mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-09-11 10:46:25 +03:00
docs: update jaeger info for ee
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9156 GitOrigin-RevId: 5e483fbee33356cf52ffabef145f709f2a8b1e46
This commit is contained in:
parent
8a9fa8d567
commit
c0e998400b
@ -189,13 +189,13 @@ Your observability tool may expect to receive certain resource attributes in ord
|
||||
resource attributes must be set with this parameter. Many, but not all, of these resource attributes will be
|
||||
[OpenTelemetry Semantic Conventions](https://opentelemetry.io/docs/concepts/semantic-conventions/).
|
||||
|
||||
Hasura automatically sets some resource attributes. The values of such attributes can be overridden by specifying
|
||||
your own value for the attribute using this parameter.
|
||||
Hasura automatically sets some resource attributes. The values of such attributes can be overridden by specifying your
|
||||
own value for the attribute using this parameter.
|
||||
|
||||
#### Default resource attributes
|
||||
|
||||
| Attribute | Type | Default |
|
||||
| --------- | ---- | ------- |
|
||||
| Attribute | Type | Default |
|
||||
| ------------------------------------------------------------------------------------------------------------ | ------ | -------- |
|
||||
| [service.name](https://opentelemetry.io/docs/reference/specification/resource/semantic_conventions/#service) | string | `hasura` |
|
||||
|
||||
:::info Attribute type support
|
||||
@ -204,14 +204,40 @@ Hasura currently only supports string-valued attributes.
|
||||
|
||||
:::
|
||||
|
||||
## Understanding traces
|
||||
## Consuming and visualizing traces
|
||||
|
||||
Use your observability tool's UI to visualize and perform further analytics on trace data to monitor, diagnose and
|
||||
troubleshoot your application. Traces and 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.
|
||||
You can utilize your observability tool's UI to visualize and perform further analytics on trace data to monitor,
|
||||
diagnose and troubleshoot your application. Typically, traces and 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. Below, we provide some
|
||||
examples of how to consume and visualize traces using popular observability tools.
|
||||
|
||||
For example, the image below shows a flame graph in [Jaeger](https://www.jaegertracing.io/) where a query took 5.64
|
||||
milliseconds in total, of which 2.78 milliseconds was the actual Postgres database processing the query.
|
||||
### Jaeger
|
||||
|
||||
To use [Jaeger](https://www.jaegertracing.io/), simply add this to your `docker-compose.yaml`:
|
||||
|
||||
```yaml
|
||||
jaeger:
|
||||
image: jaegertracing/all-in-one:1.37
|
||||
restart: always
|
||||
ports:
|
||||
- 5775:5775/udp
|
||||
- 6831:6831/udp
|
||||
- 6832:6832/udp
|
||||
- 5778:5778
|
||||
- 4002:16686
|
||||
- 14250:14250
|
||||
- 14268:14268
|
||||
- 14269:14269
|
||||
- 4317:4317 # OTLP gRPC
|
||||
- 4318:4318 # OTLP HTTP
|
||||
- 9411:9411
|
||||
environment:
|
||||
COLLECTOR_OTLP_ENABLED: 'true'
|
||||
COLLECTOR_ZIPKIN_HOST_PORT: '9411'
|
||||
```
|
||||
|
||||
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"
|
||||
@ -219,10 +245,10 @@ milliseconds in total, of which 2.78 milliseconds was the actual Postgres databa
|
||||
width="1146px"
|
||||
/>
|
||||
|
||||
## OpenTelemetry Collector
|
||||
### OpenTelemetry Collector
|
||||
|
||||
OpenTelemetry provides a [Collector](https://opentelemetry.io/docs/collector/) that can export OpenTelemetry data to
|
||||
observability tools that do not support native OpenTelemetry ingestion.
|
||||
OpenTelemetry provides the [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) that can export
|
||||
OpenTelemetry data to observability tools that do not support native OpenTelemetry ingestion.
|
||||
|
||||
To work with such observability tools, Hasura's OpenTelemetry integration can be configured to send OpenTelemetry data
|
||||
to the collector.
|
||||
|
@ -63,23 +63,5 @@ services:
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 5s
|
||||
# jaeger:
|
||||
# image: jaegertracing/all-in-one:1.37
|
||||
# restart: always
|
||||
# ports:
|
||||
# - 5775:5775/udp
|
||||
# - 6831:6831/udp
|
||||
# - 6832:6832/udp
|
||||
# - 5778:5778
|
||||
# - 4002:16686
|
||||
# - 14250:14250
|
||||
# - 14268:14268
|
||||
# - 14269:14269
|
||||
# - 4317:4317 # OTLP gRPC
|
||||
# - 4318:4318 # OTLP HTTP
|
||||
# - 9411:9411
|
||||
# environment:
|
||||
# COLLECTOR_OTLP_ENABLED: 'true'
|
||||
# COLLECTOR_ZIPKIN_HOST_PORT: '9411'
|
||||
volumes:
|
||||
db_data:
|
||||
|
@ -62,23 +62,5 @@ services:
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 5s
|
||||
# jaeger:
|
||||
# image: jaegertracing/all-in-one:1.37
|
||||
# restart: always
|
||||
# ports:
|
||||
# - 5775:5775/udp
|
||||
# - 6831:6831/udp
|
||||
# - 6832:6832/udp
|
||||
# - 5778:5778
|
||||
# - 4002:16686
|
||||
# - 14250:14250
|
||||
# - 14268:14268
|
||||
# - 14269:14269
|
||||
# - 4317:4317 # OTLP gRPC
|
||||
# - 4318:4318 # OTLP HTTP
|
||||
# - 9411:9411
|
||||
# environment:
|
||||
# COLLECTOR_OTLP_ENABLED: 'true'
|
||||
# COLLECTOR_ZIPKIN_HOST_PORT: '9411'
|
||||
volumes:
|
||||
db_data:
|
||||
|
@ -68,23 +68,5 @@ services:
|
||||
restart: always
|
||||
environment:
|
||||
MARIADB_ROOT_PASSWORD: example
|
||||
# jaeger:
|
||||
# image: jaegertracing/all-in-one:1.37
|
||||
# restart: always
|
||||
# ports:
|
||||
# - 5775:5775/udp
|
||||
# - 6831:6831/udp
|
||||
# - 6832:6832/udp
|
||||
# - 5778:5778
|
||||
# - 4002:16686
|
||||
# - 14250:14250
|
||||
# - 14268:14268
|
||||
# - 14269:14269
|
||||
# - 4317:4317 # OTLP gRPC
|
||||
# - 4318:4318 # OTLP HTTP
|
||||
# - 9411:9411
|
||||
# environment:
|
||||
# COLLECTOR_OTLP_ENABLED: 'true'
|
||||
# COLLECTOR_ZIPKIN_HOST_PORT: '9411'
|
||||
volumes:
|
||||
db_data:
|
||||
|
@ -71,23 +71,5 @@ services:
|
||||
restart: always
|
||||
environment:
|
||||
MYSQL_ROOT_PASSWORD: example
|
||||
# jaeger:
|
||||
# image: jaegertracing/all-in-one:1.37
|
||||
# restart: always
|
||||
# ports:
|
||||
# - 5775:5775/udp
|
||||
# - 6831:6831/udp
|
||||
# - 6832:6832/udp
|
||||
# - 5778:5778
|
||||
# - 4002:16686
|
||||
# - 14250:14250
|
||||
# - 14268:14268
|
||||
# - 14269:14269
|
||||
# - 4317:4317 # OTLP gRPC
|
||||
# - 4318:4318 # OTLP HTTP
|
||||
# - 9411:9411
|
||||
# environment:
|
||||
# COLLECTOR_OTLP_ENABLED: 'true'
|
||||
# COLLECTOR_ZIPKIN_HOST_PORT: '9411'
|
||||
volumes:
|
||||
db_data:
|
||||
|
@ -70,23 +70,5 @@ services:
|
||||
environment:
|
||||
- ORACLE_PASSWORD=pass
|
||||
- ORACLE_DATABASE=example
|
||||
# jaeger:
|
||||
# image: jaegertracing/all-in-one:1.37
|
||||
# restart: always
|
||||
# ports:
|
||||
# - 5775:5775/udp
|
||||
# - 6831:6831/udp
|
||||
# - 6832:6832/udp
|
||||
# - 5778:5778
|
||||
# - 4002:16686
|
||||
# - 14250:14250
|
||||
# - 14268:14268
|
||||
# - 14269:14269
|
||||
# - 4317:4317 # OTLP gRPC
|
||||
# - 4318:4318 # OTLP HTTP
|
||||
# - 9411:9411
|
||||
# environment:
|
||||
# COLLECTOR_OTLP_ENABLED: 'true'
|
||||
# COLLECTOR_ZIPKIN_HOST_PORT: '9411'
|
||||
volumes:
|
||||
db_data:
|
||||
|
@ -58,29 +58,10 @@ services:
|
||||
QUARKUS_OPENTELEMETRY_ENABLED: "false"
|
||||
## QUARKUS_OPENTELEMETRY_TRACER_EXPORTER_OTLP_ENDPOINT: http://jaeger:4317
|
||||
healthcheck:
|
||||
test:
|
||||
["CMD", "curl", "-f", "http://localhost:8081/api/v1/snowflake/health"]
|
||||
test: ["CMD", "curl", "-f", "http://localhost:8081/api/v1/snowflake/health"]
|
||||
interval: 5s
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 5s
|
||||
# jaeger:
|
||||
# image: jaegertracing/all-in-one:1.37
|
||||
# restart: always
|
||||
# ports:
|
||||
# - 5775:5775/udp
|
||||
# - 6831:6831/udp
|
||||
# - 6832:6832/udp
|
||||
# - 5778:5778
|
||||
# - 4002:16686
|
||||
# - 14250:14250
|
||||
# - 14268:14268
|
||||
# - 14269:14269
|
||||
# - 4317:4317 # OTLP gRPC
|
||||
# - 4318:4318 # OTLP HTTP
|
||||
# - 9411:9411
|
||||
# environment:
|
||||
# COLLECTOR_OTLP_ENABLED: 'true'
|
||||
# COLLECTOR_ZIPKIN_HOST_PORT: '9411'
|
||||
volumes:
|
||||
db_data:
|
||||
|
Loading…
Reference in New Issue
Block a user