Repository navigation
Observability refactor - update merge in current origin main, image fix #776
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
3755ef9
docs: move trace export pages under Integrations > Observability and …
braxtonj 67b16d2
docs: rewrite the Prometheus page from the current endpoint schema
braxtonj 18f6f91
docs: add the Observability overview, the generic OTLP export page an…
braxtonj bce8010
docs: correct the Coralogix page and the vendor export pages
braxtonj fd7d266
docs: point the Resolve traces pages at the Integrations export pages
braxtonj f67728d
docs: apply review corrections to the Prometheus and OTLP pages
braxtonj 97a4f3b
image fixes
braxtonj 2f3933a
Merge remote-tracking branch 'origin/main' into observability_refactor
braxtonj 6e88be2
merge in current origin main, image fix
braxtonj bd38402
Merge branch 'main' into observability_refactor
braxtonj 41ef019
minor tweaks to copy and docs.json cleanup
braxtonj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,121 +1,84 @@ | ||
| --- | ||
| title: 'Export Metrics & Data via Coralogix' | ||
| description: 'Deep integration with Coralogix for OpenTelemetry tracing, RUM monitoring, and alert notifications' | ||
| title: 'Send traces, RUM and alerts to Coralogix' | ||
| description: 'Send check runs to Coralogix as OpenTelemetry traces, add Coralogix RUM to Browser checks and Multistep checks, and send alerts to Coralogix Logs.' | ||
| sidebarTitle: 'Coralogix' | ||
| canonical: 'https://www.checklyhq.com/docs/integrations/observability/coralogix/' | ||
| --- | ||
|
|
||
| Checkly deeply integrates with [Coralogix](https://coralogix.com/) in three ways: | ||
| Checkly connects to [Coralogix](https://coralogix.com/) in three ways. Each one works on its own. | ||
|
|
||
| 1. Checkly can automatically instrument all check executions with **OpenTelemetry tracing** and send the data to Coralogix | ||
| as traces. | ||
| 2. Checkly can automatically instrument your Browser checks with **Coralogix RUM (Real User Monitoring)**. | ||
| 3. Checkly can send **alert notifications** when checks pass and/or fail to **Coralogix Logs**. | ||
| - **OpenTelemetry tracing**: every API check, URL monitor, Browser check and Multistep check run arrives in Coralogix as a trace, linked from the check result page. | ||
| - **RUM**: Browser checks and Multistep checks send Coralogix RUM data labeled `Checkly: true`, so you can compare synthetic and real users. | ||
| - **Alert channel**: your Checkly alert notifications arrive in Coralogix Logs. | ||
|
|
||
| ## OpenTelemetry tracing integration | ||
| ## OpenTelemetry tracing | ||
|
|
||
| To set up the OpenTelemetry tracing integration, first enable the Coralogix integration in your Checkly account in the | ||
| [integrations section](https://app.checklyhq.com/settings/account/integrations). | ||
| <Accordion title="Prerequisites"> | ||
| - A [plan](https://www.checklyhq.com/pricing/) that includes the Coralogix integration. | ||
| - A Coralogix account where you can create Send-Your-Data API keys. | ||
| </Accordion> | ||
|
|
||
|  | ||
| 1. In Coralogix, create a Send-Your-Data API key under **Settings > Users and Teams > API Keys**. See the [Coralogix API keys documentation](https://coralogix.com/docs/user-guides/account-management/api-keys/api-keys/). | ||
| 2. In Checkly, open [Settings > Integrations](https://app.checklyhq.com/settings/account/integrations) and click **Add Coralogix integration**. | ||
| 3. Pick the region of your Coralogix tenant and enter your team name. The region selects the ingest endpoint. The team name only builds the permalink shown on the check result page. | ||
| 4. Select **Enable sending traces to Coralogix**, paste the API key and save the integration. | ||
|
|
||
| 1. Pick the region of your tenant and enter the team name. We use this to determine the correct trace ingest endpoint for Coralogix. | ||
| 2. Create a "Send Your Data" API key in your Coralogix account, you can find these in the **Data Flow > API Keys** section | ||
| of your Coralogix dashboard. Copy and paste the API key. | ||
|  | ||
|
|
||
| The integration is now active and Checkly will start doing two things | ||
| Export to Coralogix depends only on the Coralogix integration being enabled. Import Traces and Export Traces on [Settings > Traces](https://app.checklyhq.com/settings/account/traces) do not need to be on. | ||
|
|
||
| 1. Send a trace for every check run to Coralogix. | ||
| 2. Instrument all HTTP requests generated by the check with the following headers: | ||
| Checkly adds `traceparent` and `tracestate` headers to the requests your checks make, so spans from your instrumented backend join the same trace. The [OTLP page](/integrations/observability/traces/otlp#trace-headers) documents both headers. | ||
|
|
||
| | Header | Value | Description | | ||
| |---------------|------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------| | ||
| | `traceparent` | `{version}-{trace_id}-{span_id}-{trace_flags}` | A trace parent ID in [the canonical w3c format](https://www.w3.org/TR/trace-context/#traceparent-header-field-values) | | ||
| | `tracestate` | `checkly=true` | A vendor specific header so you can recognize traces originating from Checkly | | ||
|  | ||
|
|
||
|  | ||
| The check result page shows the trace ID and a permalink to the trace in Coralogix. | ||
|
|
||
| Moreover, it will show a **trace ID** and a **permalink** to the recorded trace in the check result page, so you can easily | ||
| correlate the check run with the trace in Coralogix. | ||
|  | ||
|
|
||
|  | ||
| ### What is sent | ||
|
|
||
| Each trace will have the following metadata added to it as **tags**: | ||
| Exported spans carry the `checkly.*` attributes documented on the [OTLP page](/integrations/observability/traces/otlp#what-is-sent): `checkly.account.id`, `checkly.check.id`, `checkly.check.result.id`, `checkly.check.name`, `checkly.check.type`, `checkly.check.runtime`, `checkly.check.session.id`, `checkly.check.location`, `checkly.check.tags` and `checkly.check.status`. It also carries two Coralogix resource attributes: | ||
|
|
||
| | Tag | Description | | ||
| |----------------------------|---------------------------------------------------------------| | ||
| | `checkly.account.id` | The ID of the Checkly account the check belongs to. | | ||
| | `checkly.check.id` | The ID of the Checkly check that generated the trace. | | ||
| | `checkly.check.name` | The name of the Checkly check that generated the trace. | | ||
| | `checkly.check.type` | The type of the Checkly check that generated the trace. | | ||
| | `checkly.check.runtime` | The runtime ID of the Checkly check that generated the trace. | | ||
| | `checkly.check.session.id` | The unique ID of the check session the check belongs to. | | ||
| | `checkly.check.result.id` | The unique result ID of the check run. | | ||
| | `checkly.check.location` | The location ID of where the check was run, i.e. `us-east-1`. | | ||
| | Attribute | Value | | ||
| |---|---| | ||
| | `cx.application.name` | `checkly-<type>-check` | | ||
| | `cx.subsystem.name` | `<type>-check` | | ||
|
|
||
| Using these tags, you can create filters, dashboards and slice & dice your Checkly data as your runs are executed and | ||
| ingested into Coralogix as traces. | ||
| When the Coralogix integration and the generic export on Settings > Traces are both on, these `cx.*` resource attributes may also reach your generic endpoint from API checks, URL monitors, Browser checks and Multistep checks. | ||
|
|
||
| If you are using a different trace header than the standard `traceparent`, you can configure this header in the *custom | ||
| trace header* field in the integration settings. | ||
| ### Custom trace header | ||
|
|
||
| ### What's included | ||
|
|
||
| - Traces for every check execution | ||
| - HTTP request instrumentation with W3C headers | ||
| - Trace correlation metadata | ||
| If your backend reads a header other than `traceparent`, set its name in the **Custom trace header** field. When it is set, API checks and URL monitors send the custom header instead of `traceparent`, even when the generic OTLP export is also on, so backend spans no longer join those check runs by `traceparent`. Browser checks and Multistep checks send both headers unless every enabled export has a custom header. | ||
|
|
||
| <Note> | ||
| Check **metrics** (response times, availability, etc.) are not sent through this integration. To send these metrics | ||
| to Coralogix, scrape them via the [Prometheus integration](https://www.checklyhq.com/docs/integrations/observability/prometheus-v2/) | ||
| and forward to Coralogix using an OpenTelemetry Collector. | ||
| Check metrics, such as response times and availability, are not sent through this integration. To get them into Coralogix, scrape the [Prometheus endpoint](/integrations/observability/prometheus) and forward the metrics with an OpenTelemetry Collector. | ||
| </Note> | ||
|
|
||
| ## RUM integration | ||
|
|
||
| In addition to the OpenTelemetry tracing, Checkly can also send RUM data to Coralogix for all Browser checks. This enables | ||
| tracking your Playwright-powered checks to be recorded as (semi) real users, so you can compare and contrast the performance | ||
| between synthetic and real users. | ||
|
|
||
|  | ||
|
|
||
| 1. Click **Enable Coralogix RUM** and pick the region of your tenant. | ||
| 2. Set the global name of the application you will be targeting with your checks, e.g. "Acme webshop". | ||
| 3. Create a new RUM integration in your Coralogix account via **Data Flow > Integrations > Real User Monitoring** | ||
|
|
||
|  | ||
|
|
||
| 4. You will need to create an **Integration Key** and a **SourceMap Upload Key**. | ||
| Copy and paste the integration key into Checkly. | ||
|
|
||
| > Only the integration key is needed for the Checkly integration. | ||
| ## RUM | ||
|
|
||
| 5. As Checkly automatically injects the Coralogix RUM SDK to each Browser check run, uploading and setting up the SourceMap is not required. You can **skip** the **Install & setup Browser SDK Package** step and finish the set up there. | ||
| With RUM enabled, Checkly injects the Coralogix RUM SDK into your Browser checks and Multistep checks. Their RUM data reaches Coralogix with the label `Checkly: true`. | ||
|
|
||
| If you are targeting multiple applications with your checks, you can override the global application name by adding the | ||
| environment variable `CORALOGIX_RUM_APP_NAME` to your Browser check. You can find the Browser check specific environment | ||
| variables under **Settings** > **Environment variables** in the Browser check editor. | ||
|  | ||
|
|
||
| After enabling the RUM integration, Checkly will start sending RUM data to Coralogix for all Browser checks. | ||
| 1. In Coralogix, create a Send-Your-Data API key with the **SendRUMData** role preset under **Settings > Users and Teams > API Keys**. The [Coralogix RUM documentation](https://coralogix.com/docs/user-guides/rum/sdk-installation/javascript/npm-browser/) covers the Coralogix side. | ||
|  | ||
| 2. In the Coralogix integration in Checkly, select **Enable Coralogix RUM** and pick the **RUM Region** of your tenant. | ||
| 3. Set the **RUM application name** to the application your checks target, for example `my-website`. | ||
| 4. Paste the key into **RUM API key** and save the integration. | ||
|
|
||
| > Note that you do not need to install the RUM SDK in your application, Checkly will automatically inject the necessary | ||
| > JavaScript snippet into your Browser checks. However, if you have installed the SDK we will use the existing installation and not inject the snippet. | ||
| You do not need to install the RUM SDK in your application or upload source maps. If your application already loads the Coralogix RUM SDK, the injected copy skips its own initialization. | ||
|
|
||
| ## Alert channel → Coralogix Logs integration | ||
| If your checks target several applications, set the environment variable `CORALOGIX_RUM_APP_NAME` on a check to override the application name for that check. | ||
|
|
||
| You can set up Coralogix as an alert channel destination, so Coralogix receives any alert notifications you have set up as logs. | ||
| Note that you can use this integration separately from the other two integrations mentioned above. | ||
| ## Alert channel to Coralogix Logs | ||
|
|
||
| 1. In Checkly, navigate to [alert settings](https://app.checklyhq.com/alerts/settings/). Click the **Add more channels** | ||
| button, find Coralogix on the list, and click **Add channel**. | ||
| Coralogix can receive your alert notifications as logs. This alert channel works without the tracing and RUM integrations. | ||
|
|
||
|  | ||
| 1. In Checkly, go to [Alert channels](https://app.checklyhq.com/alerts/settings), click **+ Add more channels** (**New alert channel** if you have none yet), find Coralogix and click **Add channel**. | ||
|
|
||
| 2. Create a "Send Your Data" API key in your Coralogix account, you can find these in the **Data Flow > API Keys** section | ||
| of your Coralogix dashboard. Copy and paste the API key. | ||
|  | ||
|
|
||
| 2. Give your channel a name, and provide the correct Coralogix Logs API endpoint for the appropriate region, e.g. | ||
| `https://ingress.eu2.coralogix.com/logs/v1/singles` Make sure that the right checks are subscribing to the channel and | ||
| that the **Send when** rules are correctly set, then hit **Save Coralogix Webhook**. | ||
| 2. In Coralogix, create a Send-Your-Data API key under **Settings > Users and Teams > API Keys**. Paste it into the channel form. | ||
| 3. Name the channel and enter the Coralogix Logs API endpoint for your region, for example `https://ingress.eu2.coralogix.com/logs/v1/singles`. Make sure the right checks subscribe to the channel and the **Send when** rules fit, then click **Save Coralogix webhook**. | ||
|
|
||
|  | ||
|  |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Blocker: The merge dropped the end of this redirect object and the start of the next one.
docs.jsonno longer parses, which fails the Mintlify deployment andstatic-docs-checks(Expected ',' or '}' after property value ... line 2483 column 7).