mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-09-11 10:46:25 +03:00
docs: deprecate coud otel docs
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9993 GitOrigin-RevId: 2e3840e75f8e0bf56366809d06907562bb1e32b3
This commit is contained in:
Rob Dominguez
hasura-bot
parent
fcefba5349
commit
0abf4368ae
@ -171,7 +171,7 @@ import Enterprise from '@site/static/icons/features/enterprise.svg';
|
||||
<p>Learn how to configure Prometheus in Hasura Enterprise Edition to monitor your GraphQL API.</p>
|
||||
</div>
|
||||
</VersionedLink>
|
||||
<VersionedLink to="/observability/enterprise-edition/opentelemetry/">
|
||||
<VersionedLink to="/observability/opentelemetry/">
|
||||
<div className="card">
|
||||
<h3>Traces via OpenTelemetry</h3>
|
||||
<p>Learn how to configure OpenTelemetry in Hasura Enterprise Edition.</p>
|
||||
|
||||
@ -37,7 +37,7 @@ choice:
|
||||
- [New Relic](newrelic.mdx)
|
||||
- [Azure monitor](azure-monitor.mdx)
|
||||
- [Prometheus](prometheus.mdx)
|
||||
- [OpenTelemetry](opentelemetry.mdx)
|
||||
- [OpenTelemetry](/observability/opentelemetry.mdx)
|
||||
|
||||
## Log types
|
||||
|
||||
|
||||
@ -1,137 +0,0 @@
|
||||
---
|
||||
sidebar_label: OpenTelemetry
|
||||
sidebar_position: 3
|
||||
description: OpenTelemetry Integration on Hasura Cloud
|
||||
title: 'Cloud: OpenTelemetry Integration'
|
||||
keywords:
|
||||
- hasura
|
||||
- docs
|
||||
- cloud
|
||||
- traces
|
||||
- integration
|
||||
- export traces
|
||||
- opentelemetry
|
||||
- open telemetry
|
||||
---
|
||||
|
||||
import Thumbnail from '@site/src/components/Thumbnail';
|
||||
import HeadingIcon from '@site/src/components/HeadingIcon';
|
||||
import ProductBadge from '@site/src/components/ProductBadge';
|
||||
|
||||
# Export Traces to OpenTelemetry Compliant Receiver from Hasura Cloud
|
||||
|
||||
<ProductBadge standard pro ee />
|
||||
|
||||
## Introduction
|
||||
|
||||
You can export traces of your Hasura Cloud project to the [OpenTelemetry](https://opentelemetry.io/) compliant APM
|
||||
receiver. This can be configured on the Integrations tab on the project's setting page.
|
||||
|
||||
:::info Note
|
||||
|
||||
For Hasura Cloud projects, the OpenTelemetry Integration is only available on the `Professional` tier and
|
||||
above.
|
||||
|
||||
:::
|
||||
|
||||
:::info Note
|
||||
|
||||
Currently, the OpenTelemetry Integration exports only traces. The support for metrics and logs will be added once the
|
||||
OpenTelemetry spec reaches [stability](https://opentelemetry.io/status/#current-status).
|
||||
|
||||
:::
|
||||
|
||||
## Configure the OpenTelemetry integration
|
||||
|
||||
Navigate to the `Integrations` tab on the project settings page to find the OpenTelemetry integration.
|
||||
|
||||
<Thumbnail src="/img/observability/integrate-opentelemetry.png" alt="Select OpenTelemetry Integration" width="1146px" />
|
||||
|
||||
The following config parameters are needed to set up the integration with the APM receiver:
|
||||
|
||||
1. #### Endpoint
|
||||
|
||||
OpenTelemetry compliant receiver
|
||||
[endpoint](https://opentelemetry.io/docs/reference/specification/protocol/exporter/#configuration-options). The URL
|
||||
scheme (`http`/`https`) determines if SSL(TLS) should be used for the communication. Your APM vendor will provide the
|
||||
OpenTelemetry Ingestion endpoint information. The appropriate endpoint for the chosen **Connection Type** should be
|
||||
used since the APM tools usually have different endpoints for `HTTP` and `gRPC` protocols.
|
||||
|
||||
2. #### Connection Type
|
||||
|
||||
Protocol to be used for the communication with the receiver. OpenTelemetry supports connections over `gRPC` and
|
||||
`HTTP`. The APM vendor documentation contains the protocols it supports for OpenTelemetry ingestion, and `gRPC` can
|
||||
be preferred if it supports both `gRPC` and `HTTP`.
|
||||
|
||||
3. #### Batch Size
|
||||
|
||||
Batch size is the maximum number of data points (spans in the context of traces) included in every export request
|
||||
made to the APM tool. The batch size should be an integer between 1 and 512.
|
||||
|
||||
4. #### Headers
|
||||
|
||||
Headers are <em>(optionally)</em> added to every request made by Hasura to the APM receiver. APM vendors will provide
|
||||
**Authorization/API keys** with the required role/permissions to ingest OpenTelemetry data. Please refer to their
|
||||
documentation for the request header formats. Headers should be added here as a `key:value` pair.
|
||||
|
||||
5. #### Attributes
|
||||
|
||||
Attributes are <em>(optional)</em> custom tags added to the telemetry data. This is usually used to identify sources
|
||||
in a distributed tracing environment and aids in granular filtering and analytics.
|
||||
|
||||
6. #### Export Telemetry Data
|
||||
|
||||
Selects the telemetry data points to be exported. (Note: Currently only traces are supported).
|
||||
|
||||
After adding appropriate values in the OpenTelemetry Integration panel, click <em>Connect Integration</em>.
|
||||
|
||||
<Thumbnail
|
||||
src="/img/observability/configure-opentelemetry.png"
|
||||
alt="Configure OpenTelemetry Integration"
|
||||
width="437px"
|
||||
/>
|
||||
|
||||
## Checking the status of the integration
|
||||
|
||||
The green/red dot signifies the status of the integration. The green dot indicates a successful export of the telemetry
|
||||
data to the APM receiver. `Last Exported Traces` is continuously updated, indicating the timestamp of the last telemetry
|
||||
data that was successfully exported. The orange dot reading `Not exported yet` means no requests have been made to the
|
||||
GraphQL API after configuring the integration.
|
||||
|
||||
<Thumbnail
|
||||
src="/img/observability/configure-opentelemetry-done.png"
|
||||
alt="OpenTelemetry Integration successfully configured"
|
||||
width="1146px"
|
||||
/>
|
||||
|
||||
In case of errors while exporting telemetry data to the APM receiver, the dot becomes red and the error
|
||||
messages/instructions are displayed. Click the `Update Settings` button to update the config parameters.
|
||||
|
||||
<Thumbnail
|
||||
src="/img/observability/configure-opentelemetry-fail.png"
|
||||
alt="Opentelemetry Integration unable to push data"
|
||||
width="1146px"
|
||||
/>
|
||||
|
||||
## View traces
|
||||
|
||||
Use your APM vendor's UI to to visualize and perform further analytics on trace data to monitor, diagnose and
|
||||
troubleshoot your application. Traces with their spans are listed out and selecting a trace shows a flame graph
|
||||
containing a visual representation of where the operation spent its execution time. For example, the image below shows a
|
||||
flame graph in `Jaeger` where a query took 5.64 milliseconds in total, of which 2.78 milliseconds was the actual
|
||||
Postgres database processing the query.
|
||||
|
||||
<Thumbnail
|
||||
src="/img/observability/jaeger-trace-flame-graph.png"
|
||||
alt="Flame graph for a trace entry in Jaeger"
|
||||
width="1146px"
|
||||
/>
|
||||
|
||||
## OpenTelemetry collector
|
||||
|
||||
OpenTelemetry provides a [collector](https://opentelemetry.io/docs/collector/) to export data to APM tools that do not
|
||||
support native OpenTelemetry ingestion. In such cases, this OpenTelemetry integration can be configured to send the data
|
||||
to the collector. Note: This collector should be run in your infrastructure and should be reachable by the Hasura
|
||||
backend, that is configured to send the data to the APM target. The list of
|
||||
[supported exporter targets](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter) can
|
||||
be found in the [OpenTelemetry Collector repository](https://github.com/open-telemetry/opentelemetry-collector-contrib).
|
||||
@ -34,5 +34,5 @@ Check out the following guides on how to export telemetry data from Hasura Cloud
|
||||
choice:
|
||||
|
||||
- [Prometheus](prometheus/index.mdx)
|
||||
- [OpenTelemetry](opentelemetry.mdx)
|
||||
- [OpenTelemetry](/observability/opentelemetry.mdx)
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ keywords:
|
||||
- opentelemetry
|
||||
- open telemetry
|
||||
- traces
|
||||
sidebar_position: 4
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
@ -64,7 +64,7 @@ import Observability from '@site/static/icons/features/observability.svg';
|
||||
## Using Observability
|
||||
|
||||
<div className="overview-gallery">
|
||||
<VersionedLink to="/observability/cloud/opentelemetry/">
|
||||
<VersionedLink to="/observability/opentelemetry/">
|
||||
<div className="card">
|
||||
<h3>OpenTelemetry</h3>
|
||||
<p>Connect your Hasura Cloud project to OpenTelemetry-compliant services.</p>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user