Skip to content

Commit

Permalink
add coralogix exporter docs
Browse files Browse the repository at this point in the history
  • Loading branch information
povilasv committed Jul 26, 2022
1 parent 5a438b8 commit 6cdece3
Show file tree
Hide file tree
Showing 2 changed files with 146 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/config/sideBarData.js
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ export const sideBarData = [
{label: "New Relic", link: "/docs/components/otlp-exporter#new-relic"},
{label: "Splunk", link: "/docs/partners/splunk"},
{label: "Sumo Logic", link: "/docs/components/otlp-exporter#sumo-logic"},
{label: "Coralogix", link: "/docs/partners/coralogix"},
],
link: "/docs/null"
}
Expand Down
145 changes: 145 additions & 0 deletions src/docs/partners/coralogix.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
---
title: 'Coralogix Exporter'
description: Configure the AWS Distro for OpenTelemetry Collector to send metrics, traces and logs to Coralogix
path: '/docs/partners/datadog'
---

## Overview

Coralogix provides monitoring and insights into infrastructure and application performance across your entire stack. The AWS Distro for Open Telemetry includes the [Coralogix exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/master/exporter/coralogixexporter), which takes OpenTelemetry data (metrics, traces and logs) collected by the ADOT Collector and forwards it on to Coralogix. From there, you can use Coralogix tools and dashboards to analyze and solve performance problems in your distributed apps.

## Prerequisites

1. [Download the ADOT Collector](https://github.com/aws-observability/aws-otel-collector/releases).
2. [Deploy the ADOT Collector](https://aws-otel.github.io/docs/getting-started/collector).
3. [Get a copy of your Coralogix Private key and endpoints](https://coralogix.com/docs/guide-first-steps-coralogix/). If you don't have a Coralogix account, sign up for a [Coralogix Free Account](https://signup.coralogix.com/).

## Configuring the exporter

Configure the ADOT collector to send metrics, traces and logs to Coralogix by adding a `coralogix` exporter to your [OpenTelemetry configuration YAML file](https://opentelemetry.io/docs/collector/configuration/) along with your Coralogix Private key and your endpoint:

```yaml lineNumbers=true
exporters:
coralogix:
# The Coralogix traces ingress endpoint
endpoint: "<custom-traces-endpoint>"
metrics:
endpoint: "<custom-metrics-endpoint>"
logs:
endpoint: "<custom-logs-endpoint>"

# Your Coralogix private key is sensitive
private_key: "xxx"

# Data emitted by this OpenTelemetry exporter should be tagged
# in Coralogix with the following application and subsystem names
application_name: "MyBusinessEnvironment"
subsystem_name: "MyBusinessSystem"

```

## Configuring the pipeline

Finally, add a `coralogix` exporter pipeline to your `otel-collector-configuration.yml` file. This shows a `traces` pipeline:

```yaml lineNumbers=true
service:
pipelines:
traces:
receivers: [otlp]
processors: [batch]
exporters: [coralogix]
```
## Example configurations
Here is an example configuration for collecting trace data using the `otlp` receiver, a batch processor, the `coralogix` exporter with resource attributes and tags, and a trace pipeline configured with an `otlp` receiver, `batch` processor, and `coralogix` exporter:

```yaml lineNumbers=true
receivers:
otlp:
processors:
batch: {}
exporters:
coralogix:
# The Coralogix traces ingress endpoint
endpoint: "<custom-traces-endpoint>"
# Your Coralogix private key is sensitive
private_key: "xxx"
# Data emitted by this OpenTelemetry exporter should be tagged
# in Coralogix with the following application and subsystem names
application_name: "MyBusinessEnvironment"
subsystem_name: "MyBusinessSystem"
service:
pipelines:
traces:
receivers: [otlp]
processors: [batch]
exporters: [coralogix]
```

Here is an example configuration for collecting metrics data:

```yaml lineNumbers=true
receivers:
otlp:
exporters:
coralogix:
# The Coralogix metrics endpoint
metrics:
endpoint: "<coralogix-metric-endpoint>"
# Your Coralogix private key is sensitive
private_key: "xxx"
# Data emitted by this OpenTelemetry exporter should be tagged
# in Coralogix with the following application and subsystem names
application_name: "MyBusinessEnvironment"
subsystem_name: "MyBusinessSystem"
pipelines:
metrics:
receivers: [otlp]
exporters: [coralogix]
```

Here is an example configuration for collecting logs data:

```yaml lineNumbers=true
receivers:
otlp:
exporters:
coralogix:
# The Coralogix logs endpoint
logs:
endpoint: "<coralogix-logs-endpoint>"
# Your Coralogix private key is sensitive
private_key: "xxx"
# Data emitted by this OpenTelemetry exporter should be tagged
# in Coralogix with the following application and subsystem names
application_name: "MyBusinessEnvironment"
subsystem_name: "MyBusinessSystem"
pipelines:
logs:
receivers: [otlp]
exporters: [coralogix]
```

Supply the relative path to this configuration file when you start the collector by passing it in using the `--config=<path/to/configuration_file>` command line argument. For examples of supplying a configuration file, see the [AWS OpenTelemetry Collector documentation](https://aws-otel.github.io/docs/getting-started/collector) for your target platform.

## Resources

For additional information about the Coralogix exporter and environment specific onboarding instructions, visit the [Coralogix Getting Started](https://coralogix.com/docs/guide-first-steps-coralogix/) documentation or the [`open-telemetry` Github repository](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/coralogixexporter).

## Support

Need help with the Coralogx exporter? Book [Coralogix implementation session](https://calendly.com/info-coralogix/implementation).

0 comments on commit 6cdece3

Please sign in to comment.