diff --git a/docs/docs/configuration/connecting-to-data-stores/sumologic.mdx b/docs/docs/configuration/connecting-to-data-stores/sumologic.mdx index a3e2fb9f77..8ed776dbbc 100644 --- a/docs/docs/configuration/connecting-to-data-stores/sumologic.mdx +++ b/docs/docs/configuration/connecting-to-data-stores/sumologic.mdx @@ -21,11 +21,9 @@ Examples of configuring Tracetest can be found in the [`examples` folder of the Configure Tracetest to fetch trace data from Sumo Logic. -Tracetest uses Sumo Logic's **API** `https://api.sumologic.com` to fetch trace data. +- Tracetest uses Sumo Logic's **API** `https://api.sumologic.com/api/` to fetch trace data. Your Sumo Logic URL will differ based on which region you are using. [Here's a guide which Sumo Logic API endpoint to use](https://help.sumologic.com/docs/api/getting-started/#which-endpoint-should-i-should-use). -You need to know which **Access ID**, **Access Key** you are using. - -Find them in the [preferences settings](https://help.sumologic.com/docs/manage/security/access-keys/) in your Sumo Logic account. +- You need to know which **Access ID**, **Access Key** you are using. [Create your ID and Key under Administration > Security > Access Keys in your Sumo Logic account](https://help.sumologic.com/docs/manage/security/access-keys/#create-your-access-key). :::tip Need help configuring the OpenTelemetry Collector so send trace data from your application to Sumo Logic? Read more in [the reference page here](/configuration/opentelemetry-collector-configuration-file-reference). @@ -41,23 +39,24 @@ In the Web UI, (1) open Settings and, on the (2) Configure Data Store tab, selec If you prefer using the CLI, you can use this file config. -For gRPC: - ```yaml +--- type: DataStore spec: name: Sumo Logic type: sumologic sumologic: - url: "https://api.sumologic.com" + # The URL will differ based on your location. View this + # docs page to figure out which URL you need: + # https://help.sumologic.com/docs/api/getting-started/#which-endpoint-should-i-should-use + url: "https://api.sumologic.com/api/" + # Create your ID and Key under Administration > Security > Access Keys + # in your Sumo Logic account: + # https://help.sumologic.com/docs/manage/security/access-keys/#create-your-access-key accessID: "your-access-id" accessKey: "your-access-key" ``` -:::tip -The URL for Sumo Logic changes depending on the region your Sumo Logic account is deployed on. Take a look at their [documentation](https://help.sumologic.com/docs/api/getting-started/#which-endpoint-should-i-should-use) to understand more about it. -::: - Proceed to run this command in the terminal, and specify the file above. ```bash diff --git a/docs/docs/configuration/img/sumologic-settings.png b/docs/docs/configuration/img/sumologic-settings.png index ea96b3f147..d7d8a79d8a 100644 Binary files a/docs/docs/configuration/img/sumologic-settings.png and b/docs/docs/configuration/img/sumologic-settings.png differ diff --git a/docs/docs/configuration/opentelemetry-collector-configuration-file-reference.mdx b/docs/docs/configuration/opentelemetry-collector-configuration-file-reference.mdx index ac3948e7b0..254b418fd8 100644 --- a/docs/docs/configuration/opentelemetry-collector-configuration-file-reference.mdx +++ b/docs/docs/configuration/opentelemetry-collector-configuration-file-reference.mdx @@ -36,6 +36,7 @@ Currently, Tracetest supports the following data stores. Click on the respective - [OpenSearch](/configuration/connecting-to-data-stores/opensearch) - [SignalFX](/configuration/connecting-to-data-stores/signalfx) - [SigNoz](/configuration/connecting-to-data-stores/signoz) +- [Sumo Logic](/configuration/connecting-to-data-stores/sumologic) Continue reading below to learn how to configure the OpenTelemetry Collector to send trace data from your application to any of the trace data stores above. @@ -260,3 +261,36 @@ service: receivers: [otlp] # your receiver exporters: [azuremonitor] # your exporter pointing to your Azure App Insights instance ``` + +## Configure OpenTelemetry Collector to Send Traces to Sumo Logic + +You'll configure the OpenTelemetry Collector to receive traces from your system and then send them to Sumo Logic. You'll use the [Sumo Logic OpenTelemetry Collector](https://github.com/SumoLogic/sumologic-otel-collector/blob/main/docs/installation.md#installation). + +In your OpenTelemetry Collector config file, make sure to set the `exporter` to `sumologic`. Then add an `extensions` section with `sumologic` and an `installation_token` using your [Sumo Logic Installation Token](https://help.sumologic.com/docs/manage/security/installation-tokens/). + +```yaml +# collector.config.yaml + +receivers: + otlp: + protocols: + grpc: + http: + +exporters: + sumologic: + +extensions: + sumologic: + # Create an Installation Token in your account at + # Administration > Security > Installation Tokens: + # https://help.sumologic.com/docs/manage/security/installation-tokens/ + installation_token: + +service: + extensions: [sumologic] + pipelines: + traces: + receivers: [otlp] + exporters: [sumologic] +```