Skip to content

Commit d206454

Browse files
author
Heiko Holz
authored
Update EUM-Server exporter documentation (#1569)
* feat(eum): update eum server exporter documentation * feat(eum): update eum server exporter documentation, update
1 parent da9b603 commit d206454

File tree

2 files changed

+73
-21
lines changed

2 files changed

+73
-21
lines changed

inspectit-ocelot-documentation/docs/enduser-monitoring/eum-server-configuration.md

Lines changed: 70 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: eum-server-configuration
3-
title: EUM Server and Metrics Configuration
4-
sidebar_label: Server and Metrics Configuration
3+
title: EUM Server, Metrics and Exporter Configuration
4+
sidebar_label: Server, Metrics and Exporter Configuration
55
---
66

77
The configuration file defines the mapping between the concrete Boomerang metric and a OpenCensus metric, as the following sample configuration file shows:
@@ -466,21 +466,21 @@ inspectit-eum-server:
466466

467467
### Metrics
468468

469-
The EUM server comes with the same Prometheus and InfluxDB exporter as the Ocelot agent.
469+
The EUM server comes with the same Prometheus, InfluxDB and OTLP metrics exporter as the Ocelot agent.
470470
The exporter's configurations options are the same as for the [agent](metrics/metric-exporters.md).
471471
However, they are located under the `inspectit-eum-server.exporters.metrics` configuration path.
472472

473473
#### Prometheus
474-
By default, the prometheus exporter is enabled and available on port `8888`.
474+
By default, the prometheus exporter is disabled.
475475

476-
The following configuration snippet shows the default configuration of the prometheus-exporter:
476+
The following configuration snippet shows how to make the prometheus-exporter expose the metrics on port `8888`:
477477
```YAML
478478
inspectit-eum-server:
479479
exporters:
480480
metrics:
481481
prometheus:
482482
# Determines whether the prometheus exporter is enabled.
483-
enabled: true
483+
enabled: ENABLED
484484
485485
# The host of the prometheus HTTP endpoint.
486486
host: localhost
@@ -490,7 +490,7 @@ inspectit-eum-server:
490490
```
491491

492492
#### InfluxDB
493-
By default, the InfluxDB exporter is enabled, but it is not active since the url-property is not set. The property can be set via `inspectit-eum-server.exporters.metrics.influx.url`.
493+
By default, the InfluxDB exporter is enabled, but it is not active since the `endpoint`-property is not set. The property can be set via `inspectit-eum-server.exporters.metrics.influx.endpoint`.
494494

495495
The following configuration snippet makes the InfluxDB Exporter send every 15 seconds metrics to an InfluxDB available under `localhost:8086` to the database `inspectit`:
496496
```YAML
@@ -499,14 +499,14 @@ inspectit-eum-server:
499499
metrics:
500500
influx:
501501
# Determines whether the InfluxDB exporter is enabled.
502-
enabled: true
502+
enabled: IF_CONFIGURED
503503
504504
# the export interval of the metrics.
505505
export-interval: 15s
506506
507507
# The http url of influx.
508508
# If this property is not set, the InfluxDB exporter will not be started.
509-
url: "http://localhost:8086"
509+
endpoint: "http://localhost:8086"
510510
511511
# The database to write to.
512512
# If this property is not set, the InfluxDB exporter will not be started.
@@ -536,6 +536,30 @@ inspectit-eum-server:
536536
buffer-size: 40
537537
```
538538

539+
#### OTLP (Metrics)
540+
By default, the OTLP exporter is enabled, but is not active as the `endpoint`-property is not set.
541+
The property can be set via `inspectit-eum-server.exporters.metrics.otlp.endpoint`.
542+
543+
The following configuration snipped makes the OTLP exporter send metrics every 15s to an OTLP receiver located at `localhost:4317`:
544+
545+
```yaml
546+
inspectit-eum-server:
547+
exporters:
548+
metrics:
549+
# settings for the OtlpGrpcMetricExporter used in OtlpGrpcMetricExporterService
550+
otlp:
551+
enabled: ENABLED
552+
# the export interval of the metrics
553+
export-interval: 15s
554+
# the URL endpoint, e.g., http://127.0.0.1:4317
555+
endpoint: http://localhost:4317
556+
# the transport protocol, e.g., 'grpc' or 'http/protobuf'
557+
protocol: grpc
558+
# headers
559+
headers: { }
560+
# the aggregation temporality, e.g., CUMULATIVE or DELTA
561+
preferredTemporality: CUMULATIVE
562+
```
539563
### Tracing
540564

541565
:::note
@@ -545,9 +569,23 @@ To capture traces with Boomerang, a special tracing plugin must be used.
545569
More information can be found in the chapter on [installing the EUM agent](https://inspectit.github.io/inspectit-ocelot/docs/enduser-monitoring/install-eum-agent#tracing).
546570
:::
547571

548-
The EUM server supports trace data forwarding to the Jaeger exporter.
549-
The exporter is using the [Jaeger Protobuf via gRPC API](https://www.jaegertracing.io/docs/1.16/apis/#protobuf-via-grpc-stable) in order to forward trace data.
550-
By default, the Jaeger exporter is enabled, but it is not active since the `grpc` property is not set.
572+
#### Trace Exporter
573+
The EUM server comes with the same Jaeger and OTLP trace exporter as the Ocelot agent.
574+
The exporter's configurations options are the same as for the [agent](tracing/trace-exporters.md).
575+
However, they are located under the `inspectit-eum-server.exporters.tracing` configuration path.
576+
577+
##### General Trace Exporter Settings
578+
579+
These settings apply to all trace exporters and can set below the `inspectit-eum-server.exporters.tracing` property.
580+
581+
| Property | Default | Description |
582+
|-----------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
583+
| `.service-name` | `${inspectit.service-name}` | The value of this property will be used to identify the service a trace came from. Please note that changes of this property only take effect after restarting the agent. |
584+
585+
##### Jaeger
586+
InspectIT EUM Server supports thrift and gRPC Jaeger exporter.
587+
588+
By default, the Jaeger exporter is enabled, but it is not active since the `endpoint` property is not set.
551589

552590
The following configuration snippet makes the Jaeger exporter send traces to a Jaeger instance avialable under `localhost:14250`.
553591

@@ -557,21 +595,35 @@ inspectit-eum-server:
557595
tracing:
558596
jaeger:
559597
# If jaeger exporter for the OT received spans is enabled.
560-
enabled: true
598+
enabled: ENABLED
561599
562600
# Location of the jaeger gRPC API.
563601
# Either a valid NameResolver-compliant URI, or an authority string.
564602
# If this property is not set, the jaeger-exporter will not be started.
565-
grpc: localhost:14250
566-
603+
endpoint: localhost:14250
604+
# the transport protocol, e.g., 'grpc' or 'http/protobuf'
605+
protocol: grpc
567606
# service name for all exported spans.
568607
service-name: browser-js
569608
```
570609

571-
:::note
572-
The GRPC property needs to be set without protocol (e.g. `localhost:14250`)!
573-
:::
610+
##### OTLP (tracing)
611+
By default, the OTLP exporter is enabled, but is not active as the `endpoint`-property is not set.
612+
The property can be set via `inspectit-eum-server.exporters.tracing.otlp.endpoint`.
574613

614+
The following configuration snippet makes the OTLP exporter send traces to an OTLP receiver available under `localhost:4317`.
615+
```yaml
616+
inspectit-eum-server:
617+
exporters:
618+
tracing:
619+
otlp:
620+
# If OTLP exporter for the OT received spans is enabled.
621+
enabled: ENABLED
622+
# the URL endpoint, e.g., http://127.0.0.1:4317
623+
endpoint: localhost:4317
624+
# the transport protocol, e.g., 'http/thrift' or 'grpc'
625+
protocol: grpc
626+
```
575627
#### Additional Span Attributes
576628

577629
The EUM server is able to enrich a received span with additional attributes.

inspectit-ocelot-documentation/docs/metrics/metric-exporters.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,14 @@ The following properties are nested properties below the `inspectit.exporters.me
5050
5151
## InfluxDB Exporter
5252
If enabled, metrics are pushed at a specified interval directly to a given InfluxDB v1.x instance.
53-
To enable the InfluxDB Exporters, it is only required to specify the `url`.
53+
To enable the InfluxDB Exporters, it is only required to specify the `endpoint`.
5454

5555
The InfluxDB exporter provides a special handling for counter and sum metrics which is enabled by default and can be disabled using the `counters-as-differences` option.
5656
Usually, the absolute value of such counters is irrelevant when querying the data, instead you want to have the increase of it over a certain period of time.
5757
With the `counters-as-differences` option enabled, counters are preprocessed before being exported.
5858

5959
Instead of writing the absolute value of each counter into the InfluxDB, only the increase since the last export will be written.
60-
In addition no value will be exported, if the counter has not changed since the last export.
60+
In addition, no value will be exported, if the counter has not changed since the last export.
6161
This can greatly reduce the amount of data written into the InfluxDB, especially if the metrics are quite constant and won't change much.
6262

6363
The following properties are nested properties below the `inspectit.exporters.metrics.influx` property:
@@ -78,7 +78,7 @@ The following properties are nested properties below the `inspectit.exporters.me
7878
## OTLP Exporter (Metrics)
7979

8080
The OpenTelemetry Protocol (OTLP) exporters export the metrics to the desired endpoint at a specified interval.
81-
To enable the OTLP exporters, it is only required to specify the `url`.
81+
To enable the OTLP exporters, it is only required to specify the `endpoint`.
8282

8383
The following properties are nested properties below the `inspectit.exporters.metrics.otlp-grpc` property:
8484

0 commit comments

Comments
 (0)