Sumo Logic
Sumo Logic is an observability platform that provides visibility into AWS, Azure, and GCP cloud applications and infrastructure.
Sumo Logic parameters and supported features in Nobl9
- General support:
- Release channel: Stable, Beta
- Connection method: Agent, Direct
- Replay and SLI Analyzer: Not supported
- Event logs: Supported
- Query checker: Not supported
- Query parameters retrieval: Supported
- Timestamp cache persistence: Supported
- Query parameters:
- Query interval: 2 min
- Query delay: 4 min
- Jitter: 30 sec
- Timeout: 30 sec
- Agent details and minimum required versions for supported features:
- Plugin name: n9sumologic
- Query delay environment variable: SUMOLOGIC_QUERY_DELAY
- Query parameters retrieval: 0.73.2
- Timestamp cache persistence: 0.65.0
- Additional notes:
- Supported authentication using <accessId>:<accessKey>
Authenticationโ
Access ID & access keyโ
Nobl9 leverages the Search Job API | Sumo Logic documentation to call the Sumo Logic server.
To connect to Sumo Logic, you need to provide Access ID and Access Key when creating your data source in Nobl9 UI to authenticate with Sumo Logic API. Refer to Sumo Logic documentation for details on how to get your access ID and access key.
Note that Nobl9 only supports the <accessId>:<accessKey>
authentication method described in the General API Information | Sumo Logic documentation.
Currently, Nobl9 integration with Sumo Logic does not support Base64 encoded Access ID for authentication.
Service endpoint URLโ
Sumo Logic provides multiple API endpoints. These endpoints are assigned to the specific deployment. They depend on (1) your geographic location and (2) your accountโs creation date.
Nobl9 cannot determine that value automatically, and because of that, you need to specify the correct Service Endpoint URL to connect to Sumo Logic. You can see the Service Endpoint URL when you log in to your Sumo Logic account.
For the full overview of service URLs and how they correspond to API endpoints, refer to the Sumo Logic Endpoints | Sumo Logic documentation.
Adding Sumo Logic as a data sourceโ
To ensure data transmission between Nobl9 and Sumo Logic, it may be necessary to list Nobl9 IP addresses as trusted.
app.nobl9.com
instance:- 18.159.114.21
- 18.158.132.186
- 3.64.154.26
us1.nobl9.com
instance:- 34.121.54.120
- 34.123.193.191
- 34.134.71.10
- 35.192.105.150
- 35.225.248.37
- 35.226.78.175
- 104.198.44.161
You can add the Sumo Logic data source using the direct or agent connection methods.
Direct connection methodโ
Direct connection to Sumo Logic requires users to enter their credentials which Nobl9 stores safely.
Nobl9 Webโ
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Direct.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Enter the Service Endpoint URL (mandatory).
Sumo Logic provides multiple API endpoints that are assigned to a specific deployment. These endpoints depend on your geographic location and the creation date of your account. Refer to the Sumo Logic API Endpoints for more details. Example Service Endpoint URL:https://service.sumologic.com
-
Enter your Access ID (mandatory).
Refer to the Authentication section above for details. -
Enter your Access key (mandatory).
Refer to the Authentication section above for details.
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Sumo Logic integration for Query delay is
4 minutes
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in Sumo Logic integration for Query delay is
- Click Add Data Source
sloctlโ
- Create a YAML definition to set up a direct connection with Sumo Logic. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Direct
metadata:
name: sumo-logic
displayName: Sumo Logic Direct
project: default
spec:
description: Example Sumo Logic Direct
releaseChannel: stable
sumoLogic:
accessID: wzeulXAULylic8
accessKey: "[secret]"
url: https://service.sumologic.com
queryDelay:
value: 5
unit: Minute
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . โข Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. โข Must be a number less than 1440 minutes (24 hours). โข Check query delay documentation for default unit of query delay for each source. |
logCollectionEnabled optional | boolean | Optional. Defaults to false . Set to true if you'd like your direct to collect event logs. Contact us to activate it. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
sumologic.url mandatory | string | Service endpoint. See authentication for more details. |
sumologic.access-id mandatory | string, secret | Used to authenticate with Sumo Logic API. See authentication for more details. |
sumologic.access-key mandatory | string | Used to authenticate with Sumo Logic API. Service endpoint. See authentication for more details. |
- Apply your YAML definition using the
sloctl apply
command.
Agent connection methodโ
Nobl9 Webโ
Follow the instructions below to create your Sumo Logic agent connection.
- Navigate to Integrations > Sources.
- Click .
- Click the required Source button.
- Choose Agent.
-
Select one of the following Release Channels:
- The
stable
channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of abeta
release. Use it to avoid crashes and other limitations. - The
beta
channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel can change.
- The
-
Enter the Service Endpoint URL (mandatory).
- Select a Project.
Specifying a project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank, Nobl9 uses thedefault
project. - Enter a Display Name.
You can enter a user-friendly name with spaces in this field. - Enter a Name.
The name is mandatory and can only contain lowercase, alphanumeric characters, and dashes (for example,my-project-1
). Nobl9 duplicates the display name here, transforming it into the supported format, but you can edit the result. - Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it. - Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Sumo Logic integration for Query delay is
4 minutes
.
infoChanging the Query delay may affect your SLI data. For more details, check the Query delay documentation. - The default value in Sumo Logic integration for Query delay is
- Click Add Data Source
- Deploy your agent in a Kubernetes cluster or Docker container.
sloctlโ
- Create a YAML definition to set up an agent connection with Sumo Logic. For this, refer to the following example:
apiVersion: n9/v1alpha
kind: Agent
metadata:
name: sumo-logic
displayName: Sumo Logic Agent
project: default
spec:
description: Example Sumo Logic Agent
releaseChannel: stable
sumoLogic:
url: https://service.sumologic.com
queryDelay:
value: 5
unit: Minute
Field | Type | Description |
---|---|---|
queryDelay.unit mandatory | enum | Specifies the unit for the query delay. Possible values: Second | Minute . โข Check query delay documentation for default unit of query delay for each source. |
queryDelay.value mandatory | numeric | Specifies the value for the query delay. โข Must be a number less than 1440 minutes (24 hours). โข Check query delay documentation for default unit of query delay for each source. |
releaseChannel mandatory | enum | Specifies the release channel. Accepted values: beta | stable . |
Source-specific fields | ||
sumologic.url mandatory | string | Service endpoint. See authentication section above for more details. |
- Apply your YAML definition using the
sloctl apply
command. - Deploy your agent in a Kubernetes cluster or Docker container.