Skip to content

Commit

Permalink
chore(docs): updating Tracetest OTLP port (#2428)
Browse files Browse the repository at this point in the history
chore(docs): updating tracetest otlp port
  • Loading branch information
xoscar committed Apr 26, 2023
1 parent fcd4918 commit 0821dd4
Show file tree
Hide file tree
Showing 30 changed files with 64 additions and 65 deletions.
4 changes: 2 additions & 2 deletions cli/installer/tracetest.go
Expand Up @@ -56,12 +56,12 @@ func configureBackend(conf configuration, ui cliUI.UI) configuration {
conf.set("tracetest.backend.type", "otlp")
conf.set("tracetest.backend.tls.insecure", true)
conf.set("tracetest.backend.endpoint.collector", "http://otel-collector:4317")
conf.set("tracetest.backend.endpoint", "tracetest:21321")
conf.set("tracetest.backend.endpoint", "tracetest:4317")
case "kubernetes":
conf.set("tracetest.backend.type", "otlp")
conf.set("tracetest.backend.tls.insecure", true)
conf.set("tracetest.backend.endpoint.collector", "http://otel-collector.tracetest:4317")
conf.set("tracetest.backend.endpoint", "tracetest:21321")
conf.set("tracetest.backend.endpoint", "tracetest:4317")

default:
conf.set("tracetest.backend.type", "")
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/configuration/connecting-to-data-stores/datadog.md
Expand Up @@ -11,10 +11,10 @@ Examples of configuring Tracetest with Datadog can be found in the [`examples` f
In your OpenTelemetry Collector config file:

- Set the `exporter` to `otlp/tt`
- Set the `endpoint` to your Tracetest instance on port `21321`
- Set the `endpoint` to your Tracetest instance on port `4317`

:::tip
If you are running Tracetest with Docker, and Tracetest's service name is `tracetest`, then the endpoint might look like this `http://tracetest:21321`
If you are running Tracetest with Docker, and Tracetest's service name is `tracetest`, then the endpoint might look like this `http://tracetest:4317`
:::

Additionally, add another config:
Expand Down Expand Up @@ -47,7 +47,7 @@ exporters:
# Send traces to Tracetest.
# Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
otlp/tt:
endpoint: tracetest:21321
endpoint: tracetest:4317
tls:
insecure: true

Expand All @@ -73,7 +73,7 @@ service:

## Configure Tracetest to Use Datadog as a Trace Data Store

Configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. This will expose Tracetest's trace receiver on port `21321`.
Configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. This will expose Tracetest's trace receiver on port `4317`.

## Connect Tracetest to Datadog with the Web UI

Expand Down
Expand Up @@ -11,10 +11,10 @@ Examples of configuring Tracetest with Lightstep can be found in the [`examples`
In your OpenTelemetry Collector config file:

- Set the `exporter` to `otlp/tt`
- Set the `endpoint` to your Tracetest instance on port `21321`
- Set the `endpoint` to your Tracetest instance on port `4317`

:::tip
If you are running Tracetest with Docker, and Tracetest's service name is `tracetest`, then the endpoint might look like this `http://tracetest:21321`
If you are running Tracetest with Docker, and Tracetest's service name is `tracetest`, then the endpoint might look like this `http://tracetest:4317`
:::

Additionally, add another config:
Expand Down Expand Up @@ -43,7 +43,7 @@ exporters:
logLevel: debug
# OTLP for Tracetest
otlp/tt:
endpoint: tracetest:21321 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
endpoint: tracetest:4317 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
insecure: true
# OTLP for Lightstep
Expand All @@ -69,7 +69,7 @@ service:

## Configure Tracetest to Use Lightstep as a Trace Data Store

Configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. This will expose Tracetest's trace receiver on port `21321`.
Configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. This will expose Tracetest's trace receiver on port `4317`.

## Connect Tracetest to Lightstep with the Web UI

Expand Down
Expand Up @@ -11,10 +11,10 @@ Examples of configuring Tracetest with New Relic can be found in the [`examples`
In your OpenTelemetry Collector config file:

- Set the `exporter` to `otlp/tt`
- Set the `endpoint` to your Tracetest instance on port `21321`
- Set the `endpoint` to your Tracetest instance on port `4317`

:::tip
If you are running Tracetest with Docker and Tracetest's service name is `tracetest`, then the endpoint might look like this `http://tracetest:21321`
If you are running Tracetest with Docker and Tracetest's service name is `tracetest`, then the endpoint might look like this `http://tracetest:4317`
:::

Additionally, add another config:
Expand Down Expand Up @@ -43,7 +43,7 @@ exporters:
logLevel: debug
# OTLP for Tracetest
otlp/tt:
endpoint: tracetest:21321 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
endpoint: tracetest:4317 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
insecure: true
# OTLP for New Relic
Expand Down Expand Up @@ -71,7 +71,7 @@ service:

## Configure Tracetest to Use New Relic as a Trace Data Store

Configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. This will expose Tracetest's trace receiver on port `21321`.
Configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. This will expose Tracetest's trace receiver on port `4317`.

## Connect Tracetest to New Relic with the Web UI

Expand Down
@@ -1,9 +1,9 @@
# OpenTelemetry Collector

Tracetest receives trace data on port `21321`. Tracetest's trace receiver endpoint might look like:
Tracetest receives trace data on port `4317`. Tracetest's trace receiver endpoint might look like:

```
http://your-tracetest-instance.com:21321
http://your-tracetest-instance.com:4317
```

:::tip
Expand All @@ -17,10 +17,10 @@ If you don't want to use a trace data store, you can send all traces directly to
In your OpenTelemetry Collector config file:

- Set the `exporter` to `otlp/1`
- Set the `endpoint` to your Tracetest instance on port `21321`
- Set the `endpoint` to your Tracetest instance on port `4317`

:::tip
If you are running Tracetest with Docker, and Tracetest's service name is `tracetest`, then the endpoint might look like this `http://tracetest:21321`
If you are running Tracetest with Docker, and Tracetest's service name is `tracetest`, then the endpoint might look like this `http://tracetest:4317`
:::

```yaml
Expand All @@ -41,7 +41,7 @@ processors:
exporters:
# This is the exporter that will send traces to Tracetest
otlp/1:
endpoint: http://your-tracetest-instance.com:21321
endpoint: http://your-tracetest-instance.com:4317
tls:
insecure: true

Expand All @@ -58,7 +58,7 @@ service:

## Configure Tracetest to Use OpenTelemetry Collector

Configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. This will expose Tracetest's trace receiver on port `21321`.
Configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. This will expose Tracetest's trace receiver on port `4317`.

## Connect Tracetest to OpenTelemetry Collector with the Web UI

Expand Down
Expand Up @@ -30,7 +30,7 @@ The `tracetest` directory is self-contained and will run all the prerequisites f

### Docker Compose Network

All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:21321` in the `collector.config.yaml` will map to the `tracetest` service, where the port `21321` is the port where Tracetest accepts traces.
All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:4317` in the `collector.config.yaml` will map to the `tracetest` service, where the port `4317` is the port where Tracetest accepts traces.

## Python app

Expand Down Expand Up @@ -204,7 +204,7 @@ spec:

But how are traces sent to Tracetest?

The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's otlp endpoint `tracetest:21321`.
The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's otlp endpoint `tracetest:4317`.

```yaml
receivers:
Expand All @@ -221,7 +221,7 @@ exporters:
logging:
loglevel: debug
otlp/1:
endpoint: tracetest:21321
endpoint: tracetest:4317
# Send traces to Tracetest.
# Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
Expand Down
Expand Up @@ -195,7 +195,7 @@ exporters:
awsxray:
region: ${AWS_REGION}
otlp/tt:
endpoint: tracetest:21321
endpoint: tracetest:4317
tls:
insecure: true

Expand Down
Expand Up @@ -32,7 +32,7 @@ The `tracetest` directory is self-contained and will run all the prerequisites f

### Docker Compose Network

All `services` in the `docker-compose.yaml` are on the same network, defined by the `networks` section on each file, and will be reachable by hostname from within other services. E.g. `tracetest:21321` in the `collector.config.yaml` will map to the `tracetest` service, where port `21321` is the port where Tracetest accepts traces.
All `services` in the `docker-compose.yaml` are on the same network, defined by the `networks` section on each file, and will be reachable by hostname from within other services. E.g. `tracetest:4317` in the `collector.config.yaml` will map to the `tracetest` service, where port `4317` is the port where Tracetest accepts traces.

## OpenTelemetry Demo

Expand Down Expand Up @@ -196,7 +196,7 @@ spec:

**How to Send Traces to Tracetest and Datadog?**

The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's OTLP endpoint `tracetest:21321` in one pipeline, and to Datadog in another.
The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's OTLP endpoint `tracetest:4317` in one pipeline, and to Datadog in another.

Make sure to add your Datadog API Key on `datadog` exporter.

Expand All @@ -216,7 +216,7 @@ processors:
exporters:
# OTLP for Tracetest
otlp/tt:
endpoint: tracetest:21321
endpoint: tracetest:4317
# Send traces to Tracetest.
# Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
Expand Down
Expand Up @@ -32,7 +32,7 @@ The `tracetest` directory is self-contained and will run all the prerequisites f

### Docker Compose Network

All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:21321` in the `collector.config.yaml` will map to the `tracetest` service, where the port `21321` is the port where Tracetest accepts traces.
All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:4317` in the `collector.config.yaml` will map to the `tracetest` service, where the port `4317` is the port where Tracetest accepts traces.

## OpenTelemetry Demo

Expand Down Expand Up @@ -180,7 +180,7 @@ spec:

**How to send traces to Tracetest and Lightstep?**

The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's OTLP endpoint `tracetest:21321` in one pipeline, and to Lightstep in another.
The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's OTLP endpoint `tracetest:4317` in one pipeline, and to Lightstep in another.

Make sure to add your Lightstep access token in the headers of the `otlp/ls` exporter.

Expand All @@ -200,7 +200,7 @@ exporters:
logLevel: debug
# OTLP for Tracetest
otlp/tt:
endpoint: tracetest:21321 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
endpoint: tracetest:4317 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
insecure: true
# OTLP for Lightstep
Expand Down
Expand Up @@ -32,7 +32,7 @@ The `tracetest` directory is self-contained and will run all the prerequisites f

### Docker Compose Network

All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:21321` in the `collector.config.yaml` will map to the `tracetest` service, where the port `21321` is the port where Tracetest accepts traces.
All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:4317` in the `collector.config.yaml` will map to the `tracetest` service, where the port `4317` is the port where Tracetest accepts traces.

## OpenTelemetry Demo

Expand Down Expand Up @@ -176,7 +176,7 @@ spec:

**How to send traces to Tracetest and New Relic?**

The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's OTLP endpoint `tracetest:21321` in one pipeline, and to New Relic in another.
The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's OTLP endpoint `tracetest:4317` in one pipeline, and to New Relic in another.

Make sure to add your New Relic ingest licence key in the headers of the `otlp/nr` exporter.
You access the licence key in your New Relic account settings.
Expand Down Expand Up @@ -205,7 +205,7 @@ exporters:
logLevel: debug
# OTLP for Tracetest
otlp/tt:
endpoint: tracetest:21321 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
endpoint: tracetest:4317 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
insecure: true
# OTLP for New Relic
Expand Down
Expand Up @@ -158,7 +158,7 @@ pod/tracetest-postgresql-0 1/1 Running 0 5m42s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/otel-collector ClusterIP 10.96.173.226 <none> 4317/TCP 5m46s
service/tracetest ClusterIP 10.96.248.146 <none> 11633/TCP,21321/TCP 5m42s
service/tracetest ClusterIP 10.96.248.146 <none> 11633/TCP,4317/TCP 5m42s
service/tracetest-postgresql ClusterIP 10.96.155.147 <none> 5432/TCP 5m42s
service/tracetest-postgresql-hl ClusterIP None <none> 5432/TCP 5m42s
Expand Down
Expand Up @@ -29,8 +29,7 @@ The `docker-compose.yaml` file, `collector.config.yaml`, `tracetest-provision.ya
The `tracetest` directory is self-contained and will run all the prerequisites for enabling OpenTelemetry traces and trace-based testing with Tracetest.

### Docker Compose Network

All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:21321` in the `collector.config.yaml` will map to the `tracetest` service, where the port `21321` is the port where Tracetest accepts traces.
All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:4317` in the `collector.config.yaml` will map to the `tracetest` service, where the port `4317` is the port where Tracetest accepts traces.

## Node.js app

Expand Down Expand Up @@ -259,7 +258,7 @@ spec:

But how are traces sent to Tracetest?

The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's otlp endpoint `tracetest:21321`.
The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's otlp endpoint `tracetest:4317`.

```yaml
receivers:
Expand All @@ -276,7 +275,7 @@ exporters:
logging:
loglevel: debug
otlp/1:
endpoint: tracetest:21321
endpoint: tracetest:4317
# Send traces to Tracetest.
# Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
Expand Down
Expand Up @@ -27,7 +27,7 @@ The `docker-compose.yaml` file, `collector.config.yaml`, `tracetest-provision.ya
The `tracetest` directory is self-contained and will run all the prerequisites for enabling OpenTelemetry traces and trace-based testing with Tracetest.

### Docker Compose Network
All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:21321` in the `collector.config.yaml` will map to the `tracetest` service, where the port `21321` is the port where Tracetest accepts traces.
All `services` in the `docker-compose.yaml` are on the same network and will be reachable by hostname from within other services. E.g. `tracetest:4317` in the `collector.config.yaml` will map to the `tracetest` service, where the port `4317` is the port where Tracetest accepts traces.

## Node.js app

Expand Down Expand Up @@ -198,7 +198,7 @@ The `tracetest-provision.yaml` file provisions the trace data store and polling

But how are traces sent to Tracetest?

The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's otlp endpoint `tracetest:21321`.
The `collector.config.yaml` explains that. It receives traces via either `grpc` or `http`. Then, exports them to Tracetest's otlp endpoint `tracetest:4317`.

```yaml
receivers:
Expand All @@ -215,7 +215,7 @@ exporters:
logging:
loglevel: debug
otlp/1:
endpoint: tracetest:21321
endpoint: tracetest:4317
# Send traces to Tracetest.
# Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
Expand Down
Expand Up @@ -13,7 +13,7 @@ processors:
exporters:
# OTLP for Tracetest
otlp/tt:
endpoint: tracetest:21321 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
endpoint: tracetest:4317 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
insecure: true
# Datadog exporter
Expand Down
2 changes: 1 addition & 1 deletion examples/quick-start-go/tracetest/collector.config.yaml
Expand Up @@ -12,7 +12,7 @@ exporters:
logging:
loglevel: debug
otlp/1:
endpoint: tracetest:21321 # Send traces to Tracetest. Read more in docs here. (TODO ADD LINK)
endpoint: tracetest:4317 # Send traces to Tracetest. Read more in docs here. (TODO ADD LINK)
tls:
insecure: true

Expand Down
Expand Up @@ -12,7 +12,7 @@ exporters:
logging:
loglevel: debug
otlp/1:
endpoint: tracetest:21321 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
endpoint: tracetest:4317 # Send traces to Tracetest. Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
insecure: true

Expand Down
Expand Up @@ -12,7 +12,7 @@ exporters:
logging:
loglevel: debug
otlp/1:
endpoint: tracetest:21321
endpoint: tracetest:4317
# Send traces to Tracetest.
# Read more in docs here: https://docs.tracetest.io/configuration/connecting-to-data-stores/opentelemetry-collector
tls:
Expand Down
Expand Up @@ -12,7 +12,7 @@ exporters:
logging:
loglevel: debug
otlp/1:
endpoint: tracetest:21321 # Send traces to Tracetest. Read more in docs here. (TODO ADD LINK)
endpoint: tracetest:4317 # Send traces to Tracetest. Read more in docs here. (TODO ADD LINK)
tls:
insecure: true

Expand Down

0 comments on commit 0821dd4

Please sign in to comment.