Skip to main content

Asana Source

asana-icon

The Asana Audit Logs API Integration ingests events from Asana Audit Logs API. Asana can help you to break down large work into manageable tasks. It's a comprehensive work management tool that allows you to track project and task progress, share files, comments, and notes, and keep track of deadlines.

Prerequisites

  • Only Service Accounts in Enterprise Domains can access audit log API endpoints.
  • Your Service account's Personal Access Token (PAT) is required.

Data Source

The Asana Audit Logs Integration fetches audit logs every 5 mins using GetAuditLogs source.

Setup and Configuration

Follow the below steps to get the required fields for user configuration:

  1. Log in to your Asana Enterprise Account.
    asana-login
  2. After logging in, click the Apps tab from with your admin console.
  3. Click Service accounts.
  4. Click the Add service account button.
  5. Refer to the below image for the same:
    add_service_account
  6. Copy the Personal Access Token (PAT) from here for further use.
    pat
  7. Click Save changes to save the PAT token for your service account.
  8. Inspect the URL and parse the workspace ID of your service account.
    workspace_id

States

The Asana integration Source is a device security platform that discover devices, tracks behavior, detects threats, and takes action to protect your business. When you create an Asana Source, it goes through the following stages:

  1. Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
  2. Started. A collection task is created on the Hosted Collector.
  3. Initialized. The task configuration is complete in Sumo Logic.
  4. Authenticated. The Source successfully authenticated with Asana.
  5. Collecting. The Source is actively collecting data from Asana.

If the Source has any issues during any one of these states, it is placed in an Error state.

When you delete the Source, it is placed in a Stopping state. When it has successfully stopped, it is deleted from your Hosted Collector. On the Collection page, the Health and Status for Sources is displayed. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.

Create Asana Source

When you create an Asana Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector.

To configure an Asana Source:

  1. In Sumo Logic, select Manage Data > Collection > Collection
  2. On the Collection page, click Add Source next to a Hosted Collector.
  3. Search for and select Asana.
    asana-icon
  4. Enter a Name for the Source. The description is optional.
    asana-config-main.png
  5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
  6. (Optional) Fields. Click the +Add button to define the fields you want to associate. Each field needs a name (key) and value.
    • green check circle.png A green circle with a check mark is shown when the field exists in the Fields table schema.
    • orange exclamation point.png An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
  7. Enter the Personal Access Token (PAT) from the Asana platform.
  8. Enter the unique workspace ID for the users service account.

Error Types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason for the error, if the source attempts to retry, and the name of the event log in the Health Event Index.

TypeReasonRetriesRetry BehaviorHealth Event Name
ThirdPartyConfigNormally due to an invalid configuration. You'll need to review your Source configuration and make an update.No retries are attempted until the Source is updated.Not applicableThirdPartyConfigError
ThirdPartyGenericNormally due to an error communicating with the third-party service APIs.YesThe Source will retry indefinitely.ThirdPartyGenericError
FirstPartyGenericNormally due to an error communicating with the internal Sumo Logic APIs.YesThe Source will retry indefinitely.FirstPartyGenericError

Restarting your Source

If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.

UI

To restart your source in the Sumo Logic platform, follow the steps below:

  1. Open the Collection page, and go to Manage Data > Collection > Collection.
  2. Select the source and click the information icon on the right side of the row.
  3. The API usage information popup is displayed. Click the Restart Source button on the bottom left.
    restart-source-button
  4. Click Confirm to send the restart request.
    restart-source-confirm
  5. The bottom left of the platform will provide a notification informing you the request was successful.
    restart-source-initiated

API

To restart your source using the Sumo Management API, follow the instructions below:

  • Method: POST
  • Example endpoint:
    https://api.sumologic.com/api/v1/collectors/{collector_id}/sources/{source_id}/action/restart

Sumo Logic endpoints like api.sumologic.com are different in deployments outside us1. For example, an API endpoint in Europe would begin api.eu.sumologic.com. A service endpoint in us2 (Western U.S.) would begin service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.

JSON Configuration

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details. 

ParameterTypeRequiredDescriptionAccess
configJSON ObjectYesContains the configuration-parameters of the Source.na
schemaRefJSON ObjectYesUse {"type":"Asana"} for Asana Source.not modifiable
sourceTypeStringYesUse Universal for Asana Source.not modifiable

Config Parameters

ParameterTypeRequiredDescriptionAccess
nameStringYesType the desired name of the Source and it must be unique per Collector. This value is assigned to the metadata field _sourcemodifiable
descriptionStringNoType the description of the Source.modifiable
categoryStringNoType the category of the source. This value is assigned to the metadata field _sourceCategory.modifiable
fieldsJSON ObjectNoJSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.modifiable
personalAccessTokenStringYesPersonal Access Token from the Asana platform.modifiable
workspaceIDStringYesThis will be the unique workspace id for the users service account.modifiable

JSON Example

{
"api.version":"v1",
"source":{
"config":{
"name":"Asana",
"description":"Test Source",
"category":"source_category",
"personalAccessToken":"****************************",
"workspaceID":"1204094735693514"
},
"schemaRef":{
"type":"Asana"
},
"sourceType":"Security"
}
}
Legal
Privacy Statement
Terms of Use

Copyright © 2023 by Sumo Logic, Inc.