Skip to content
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

Closes #1434: Fix Divergence of Documentation for Default Config and Default Config itself #1435

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ inspectit:
enabled: IF_CONFIGURED
# the export interval of the metrics
export-interval: ${inspectit.metrics.frequency}
# the gRPC API endpoint, e.g., http://127.0.0.1:4318
# the URL endpoint, e.g., http://127.0.0.1:4317
endpoint: null
# the transport protocol, e.g., 'grpc' or 'http/protobuf'
protocol: null
Expand Down
13 changes: 7 additions & 6 deletions inspectit-ocelot-documentation/docs/metrics/metric-exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ inspectIT Ocelot currently supports the following metrics exporters:
|[InfluxDB Exporter](#influxdb-exporter)|Yes|Push|No|
|[OTLP Exporter (Metrics)](#otlp-exporter-metrics) [[Homepage](https://github.com/open-telemetry/opentelemetry-java/tree/main/exporters/otlp/metrics)]|Yes|Push|No|

>**Important note**: Starting with version <mark>`2.X.X`</mark>, inspectIT Ocelot moved from OpenCensus to OpenTelemetry. As a result, the `OpenCensus Agent Exporter` is no longer supported.
>**Important note**: Starting with version `2.0.0`, inspectIT Ocelot moved from OpenCensus to OpenTelemetry. As a result, the `OpenCensus Agent Exporter` is no longer supported.

## Logging Exporter (Metrics)

Expand Down Expand Up @@ -82,14 +82,15 @@ To enable the OTLP exporters, it is only required to specify the `url`.

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

| Property | Default | Description |
| ----------- | ---------- | ------------------------------------------------------------ |
| `.enabled` | `DISABLED` | If `ENABLED` or `IF_CONFIGURED`, the inspectIT Ocelot agent will try to start the OTLP gRPC metrics exporter. |
| `.endpoint` | `null` | The OTLP endpoint to connect to, e.g. `http://localhost:4317` |
| `.protocol` | `grpc` | The transport protocol, see [OTEL documentation](https://opentelemetry.io/docs/reference/specification/protocol/exporter/). Supported protocols are `grpc` and `http/protobuf`. |
| Property | Default | Description |
| ----------- |-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `.enabled` | `IF_CONFIGURED` | If `ENABLED` or `IF_CONFIGURED`, the inspectIT Ocelot agent will try to start the OTLP gRPC metrics exporter. |
| `.endpoint` | `null` | Target to which the exporter is going to send metrics, e.g. `http://localhost:4317` |
| `.protocol` | `null` | The transport protocol, see [OTEL documentation](https://opentelemetry.io/docs/reference/specification/protocol/exporter/). Supported protocols are `grpc` and `http/protobuf`. |

To make inspectIT Ocelot push the metris via OTLP to, e.g. an OpenTelemetry Collector running on the same machine as the agent, the following JVM property can be used:

```
-Dinspectit.exporters.metrics.otlp.endpoint=http://127.0.0.1:4317
-Dinspectit.exporters.metrics.otlp.protocol=grpc
```
25 changes: 13 additions & 12 deletions inspectit-ocelot-documentation/docs/tracing/trace-exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ inspectIT Ocelot currently supports the following trace exporters:
* [Jaeger](#jaeger-exporter) [[Homepage](https://www.jaegertracing.io/)]
* [OTLP (Traces)](#otlp-exporter-traces) [[Homepage](https://github.com/open-telemetry/opentelemetry-java/tree/main/exporters/otlp/trace)]

>**Important note**: Starting with version <mark>`2.X.0`</mark>, inspectIT Ocelot moved from OpenCensus to OpenTelemetry. As a result, the `OpenCensus Agent Exporter` is no longer supported and has been removed.
>**Important note**: Starting with version `2.0.0` inspectIT Ocelot moved from OpenCensus to OpenTelemetry. As a result, the `OpenCensus Agent Exporter` is no longer supported and has been removed.
> Additionally, with OpenTelemetry, inspectIT Ocelot does not support the `service-name` property for individual exporter services anymore. Thus, we removed the `service-name` property from the Jaeger and Zipkin exporter. Please use the global `inspectit.service-name` property instead.

## Logging Exporter (Traces)
Expand Down Expand Up @@ -57,11 +57,11 @@ By default, the Jaeger exporters are enabled but the URL/gRPC endpoint needed fo

The following properties are nested properties below the `inspectit.exporters.tracing.jaeger` property:

|Property |Default| Description|
|---|---|---|
|`.enabled`|`IF_CONFIGURED`|If `ENABLED` or `IF_CONFIGURED`, the agent will try to start the Jaeger exporter. If the url is not set, it will log a warning if set to `ENABLED` but fail silently if set to `IF_CONFIGURED`.|
|`.endpoint`|`null`|URL endpoint under which the Jaeger server can be accessed (e.g. http://127.0.0.1:14268/api/traces).|
|`.protocol`|`grpc`|The transport protocol. Supported protocols are `grpc` and `http/thrift`.|
|Property | Default | Description|
|---|-----------------|---|
|`.enabled`| `IF_CONFIGURED` |If `ENABLED` or `IF_CONFIGURED`, the agent will try to start the Jaeger exporter. If the url is not set, it will log a warning if set to `ENABLED` but fail silently if set to `IF_CONFIGURED`.|
|`.endpoint`| `null` |URL endpoint under which the Jaeger server can be accessed (e.g. http://127.0.0.1:14268/api/traces).|
|`.protocol`| `null` |The transport protocol. Supported protocols are `grpc` and `http/thrift`.|

To make inspectIT Ocelot push the spans to a Jaeger server running on the same machine as the agent, the following JVM property can be used:

Expand All @@ -76,14 +76,15 @@ By default, the OTLP exporters are enabled but the URL endpoint needed for the e

The following properties are nested properties below the `inspectit.exporters.traces.otlp` property:

| Property | Default | Description |
| ----------- | ---------- | ------------------------------------------------------------ |
| `.enabled` | `DISABLED` | If `ENABLED` or `IF_CONFIGURED`, the inspectIT Ocelot agent will try to start the OTLP gRPC trace exporter. |
| `.endpoint` | `null` | The OTLP endpoint to connect to, e.g. `http://localhost:4317` |
| `.protocol` | `grpc` | The transport protocol, see [OTEL documentation](https://opentelemetry.io/docs/reference/specification/protocol/exporter/). Supported protocols are `grpc` and `http/protobuf`. |
| Property | Default | Description |
| ----------- |------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `.enabled` | `IF_CONFIGURED` | If `ENABLED` or `IF_CONFIGURED`, the inspectIT Ocelot agent will try to start the OTLP gRPC trace exporter. |
| `.endpoint` | `null` | Target to which the exporter is going to send traces, e.g. `http://localhost:4317` |
| `.protocol` | `null` | The transport protocol, see [OTEL documentation](https://opentelemetry.io/docs/reference/specification/protocol/exporter/). Supported protocols are `grpc` and `http/protobuf`. |

To make inspectIT Ocelot push the spans via OTLP to, e.g. an OpenTelemetry Collector running on the same machine as the agent, the following JVM property can be used:

```
-Dinspectit.exporters.tracing.otlp.endpoint=http://127.0.0.1:4318
-Dinspectit.exporters.tracing.otlp.endpoint=http://127.0.0.1:4317
-Dinspectit.exporters.tracing.otlp.protocol=grpc
```
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
id: version-2.0.0-metric-exporters
id: metric-exporters
title: Metrics Exporters
original_id: metric-exporters
---

Metrics exporters are responsible for passing the recorded metrics to a metric storage.
Expand All @@ -20,11 +19,11 @@ inspectIT Ocelot currently supports the following metrics exporters:
|[InfluxDB Exporter](#influxdb-exporter)|Yes|Push|No|
|[OTLP Exporter (Metrics)](#otlp-exporter-metrics) [[Homepage](https://github.com/open-telemetry/opentelemetry-java/tree/main/exporters/otlp/metrics)]|Yes|Push|No|

>**Important note**: Starting with version <mark>`2.X.X`</mark>, inspectIT Ocelot moved from OpenCensus to OpenTelemetry. As a result, the `OpenCensus Agent Exporter` is no longer supported.
>**Important note**: Starting with version `2.0.0`, inspectIT Ocelot moved from OpenCensus to OpenTelemetry. As a result, the `OpenCensus Agent Exporter` is no longer supported.

## Logging Exporter (Metrics)

The Logging exporter exports the metrics to the system log. By default, the exporter is disabled.
The Logging exporter exports the metrics to the system log. By default, the exporter is disabled.
The following properties are nested properties below the `inspectit.exporters.metrics.logging`:

|Property |Default| Description
Expand Down Expand Up @@ -78,19 +77,20 @@ The following properties are nested properties below the `inspectit.exporters.me

## OTLP Exporter (Metrics)

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

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

| Property | Default | Description |
| ----------- | ---------- | ------------------------------------------------------------ |
| `.enabled` | `DISABLED` | If `ENABLED` or `IF_CONFIGURED`, the inspectIT Ocelot agent will try to start the OTLP gRPC metrics exporter. |
| `.endpoint` | `null` | The OTLP endpoint to connect to, e.g. `http://localhost:4317` |
| `.protocol` | `grpc` | The transport protocol, see [OTEL documentation](https://opentelemetry.io/docs/reference/specification/protocol/exporter/). Supported protocols are `grpc` and `http/protobuf`. |
| Property | Default | Description |
| ----------- |-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `.enabled` | `IF_CONFIGURED` | If `ENABLED` or `IF_CONFIGURED`, the inspectIT Ocelot agent will try to start the OTLP gRPC metrics exporter. |
| `.endpoint` | `null` | Target to which the exporter is going to send metrics, e.g. `http://localhost:4317` |
| `.protocol` | `null` | The transport protocol, see [OTEL documentation](https://opentelemetry.io/docs/reference/specification/protocol/exporter/). Supported protocols are `grpc` and `http/protobuf`. |

To make inspectIT Ocelot push the metris via OTLP to, e.g. an OpenTelemetry Collector running on the same machine as the agent, the following JVM property can be used:

```
-Dinspectit.exporters.metrics.otlp.endpoint=http://127.0.0.1:4317
-Dinspectit.exporters.metrics.otlp.protocol=grpc
```
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ By default, the Jaeger exporters are enabled but the URL/gRPC endpoint needed fo

The following properties are nested properties below the `inspectit.exporters.tracing.jaeger` property:

|Property |Default| Description|
|---|---|---|
|`.enabled`|`IF_CONFIGURED`|If `ENABLED` or `IF_CONFIGURED`, the agent will try to start the Jaeger exporter. If the url is not set, it will log a warning if set to `ENABLED` but fail silently if set to `IF_CONFIGURED`.|
|`.endpoint`|`null`|URL endpoint under which the Jaeger server can be accessed (e.g. http://127.0.0.1:14268/api/traces).|
|`.protocol`|`grpc`|The transport protocol. Supported protocols are `grpc` and `http/thrift`.|
|Property | Default | Description|
|---|-----------------|---|
|`.enabled`| `IF_CONFIGURED` |If `ENABLED` or `IF_CONFIGURED`, the agent will try to start the Jaeger exporter. If the url is not set, it will log a warning if set to `ENABLED` but fail silently if set to `IF_CONFIGURED`.|
|`.endpoint`| `null` |URL endpoint under which the Jaeger server can be accessed (e.g. http://127.0.0.1:14268/api/traces).|
|`.protocol`| `null` |The transport protocol. Supported protocols are `grpc` and `http/thrift`.|

To make inspectIT Ocelot push the spans to a Jaeger server running on the same machine as the agent, the following JVM property can be used:

Expand All @@ -77,14 +77,15 @@ By default, the OTLP exporters are enabled but the URL endpoint needed for the e

The following properties are nested properties below the `inspectit.exporters.traces.otlp` property:

| Property | Default | Description |
| ----------- | ---------- | ------------------------------------------------------------ |
| `.enabled` | `DISABLED` | If `ENABLED` or `IF_CONFIGURED`, the inspectIT Ocelot agent will try to start the OTLP gRPC trace exporter. |
| `.endpoint` | `null` | The OTLP endpoint to connect to, e.g. `http://localhost:4317` |
| `.protocol` | `grpc` | The transport protocol, see [OTEL documentation](https://opentelemetry.io/docs/reference/specification/protocol/exporter/). Supported protocols are `grpc` and `http/protobuf`. |
| Property | Default | Description |
| ----------- |-----------------| ------------------------------------------------------------ |
| `.enabled` | `IF_CONFIGURED` | If `ENABLED` or `IF_CONFIGURED`, the inspectIT Ocelot agent will try to start the OTLP gRPC trace exporter. |
| `.endpoint` | `null` | Target to which the exporter is going to connect to, e.g. `http://localhost:4317` |
| `.protocol` | `null` | The transport protocol, see [OTEL documentation](https://opentelemetry.io/docs/reference/specification/protocol/exporter/). Supported protocols are `grpc` and `http/protobuf`. |

To make inspectIT Ocelot push the spans via OTLP to, e.g. an OpenTelemetry Collector running on the same machine as the agent, the following JVM property can be used:

```
-Dinspectit.exporters.tracing.otlp.endpoint=http://127.0.0.1:4318
-Dinspectit.exporters.tracing.otlp.endpoint=http://127.0.0.1:4317
-Dinspectit.exporters.tracing.otlp.protocol=grpc
```