Skip to content

Commit

Permalink
[docs] fixes examples/readmes link to recipes (#1886)
Browse files Browse the repository at this point in the history
* docs(config): replace config file with webui.cli

* docs(recipes+examples): add link from examples to recipes
  • Loading branch information
adnanrahic committed Jan 25, 2023
1 parent 2633a01 commit 11a1c86
Show file tree
Hide file tree
Showing 26 changed files with 219 additions and 2,068 deletions.
47 changes: 21 additions & 26 deletions docs/docs/configuration/connecting-to-data-stores/jaeger.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,45 +42,40 @@ service:
receivers: [otlp] # your receiver
processors: [batch] # make sure to add the batch processor
exporters: [jaeger] # your exporter pointing to your Jaeger instance

```

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

You also have to configure your Tracetest instance to make it aware that it has to fetch trace data from Jaeger.

Edit your configuration file to include this configuration:
Make sure you know what your Jaeger endpoint for fetching traces is. In the screenshot below, the endpoint is `jaeger:16685`.

```yaml
# tracetest.config.yaml

postgresConnString: "host=postgres user=postgres password=postgres port=5432 sslmode=disable"
### Web UI

poolingConfig:
maxWaitTimeForTrace: 10m
retryDelay: 5s
In the Web UI, open settings, and select Jaeger.

googleAnalytics:
enabled: true
![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1674643178/Blogposts/Docs/screely-1674643170953_vazb9h.png)

demo:
enabled: []

experimentalFeatures: []
### CLI

telemetry:
dataStores:
jaeger:
type: jaeger
jaeger:
endpoint: jaeger:16685
tls:
insecure: true
Or, if you prefer using the CLI, you can use this file config.

```yaml
type: DataStore
spec:
name: jaeger
type: jaeger
isDefault: true
jaeger:
endpoint: jaeger:16685
tls:
insecure: true
```

server:
telemetry:
dataStore: jaeger
exporter: collector
applicationExporter: collector
Proceed to run this command in the terminal, and specify the file above.

```bash
tracetest datastore apply -f my/data-store/file/location.yaml
```
54 changes: 23 additions & 31 deletions docs/docs/configuration/connecting-to-data-stores/lightstep.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,39 +56,31 @@ service:
exporters: [logging, otlp/ls] # your exporter pointing to your lighstep account
```

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

You also have to configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. Edit your configuration file to include this configuration:
You also have to configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector.

### Web UI

In the Web UI, open settings, and select Lightstep.

![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1674643396/Blogposts/Docs/screely-1674643391899_w6k22s.png)


### CLI

Or, if you prefer using the CLI, you can use this file config.

```yaml
# tracetest.config.yaml

postgresConnString: "host=postgres user=postgres password=postgres port=5432 sslmode=disable"

poolingConfig:
maxWaitTimeForTrace: 10s
retryDelay: 1s

googleAnalytics:
enabled: true

telemetry:
dataStores:
otlp:
type: otlp
exporters:
collector:
serviceName: tracetest
sampling: 100 # 100%
exporter:
type: collector
collector:
endpoint: otel-collector:4317

server:
telemetry:
dataStore: otlp
exporter: collector
applicationExporter: collector
type: DataStore
spec:
name: Opentelemetry Collector pipeline
type: otlp
isDefault: true
```

Proceed to run this command in the terminal, and specify the file above.

```bash
tracetest datastore apply -f my/data-store/file/location.yaml
```
54 changes: 23 additions & 31 deletions docs/docs/configuration/connecting-to-data-stores/new-relic.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,39 +59,31 @@ service:

```

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

You also have to configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector. Edit your configuration file to include this configuration:
You also have to configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector.

### Web UI

In the Web UI, open settings, and select New Relic.

![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1674643685/Blogposts/Docs/screely-1674643680615_de8fry.png)


### CLI

Or, if you prefer using the CLI, you can use this file config.

```yaml
# tracetest.config.yaml

postgresConnString: "host=postgres user=postgres password=postgres port=5432 sslmode=disable"

poolingConfig:
maxWaitTimeForTrace: 10s
retryDelay: 1s

googleAnalytics:
enabled: true

telemetry:
dataStores:
otlp:
type: otlp
exporters:
collector:
serviceName: tracetest
sampling: 100 # 100%
exporter:
type: collector
collector:
endpoint: otel-collector:4317

server:
telemetry:
dataStore: otlp
exporter: collector
applicationExporter: collector
type: DataStore
spec:
name: Opentelemetry Collector pipeline
type: otlp
isDefault: true
```

Proceed to run this command in the terminal, and specify the file above.

```bash
tracetest datastore apply -f my/data-store/file/location.yaml
```
47 changes: 21 additions & 26 deletions docs/docs/configuration/connecting-to-data-stores/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,40 +50,35 @@ service:

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

You also have to configure your Tracetest instance to make it aware that it has to fetch trace data from Jaeger.
You also have to configure your Tracetest instance to make it aware that it has to fetch trace data from OpenSearch.

Edit your configuration file to include this configuration:
Make sure you know which Index name and Address you are using. In the screenshot below, the Index name is `traces`, the Address is `http://opensearch:9200`.

```yaml
# tracetest.config.yaml
### Web UI

postgresConnString: "host=postgres user=postgres password=postgres port=5432 sslmode=disable"
In the Web UI, open settings, and select OpenSearch.

poolingConfig:
maxWaitTimeForTrace: 10m
retryDelay: 5s
![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1674644099/Blogposts/Docs/screely-1674644094600_svcwp6.png)

googleAnalytics:
enabled: true

demo:
enabled: []
### CLI

experimentalFeatures: []
Or, if you prefer using the CLI, you can use this file config.

telemetry:
dataStores:
opensearch:
type: opensearch
opensearch:
addresses:
- http://opensearch:9200 # This value is from the OpenSearch data store configuration.
index: traces
```yaml
type: DataStore
spec:
name: OpenSearch Data Store
type: openSearch
isDefault: true
opensearch:
addresses:
- http://opensearch:9200
index: traces
```

server:
telemetry:
dataStore: opensearch
exporter: collector
applicationExporter: collector
Proceed to run this command in the terminal, and specify the file above.

```bash
tracetest datastore apply -f my/data-store/file/location.yaml
```
Original file line number Diff line number Diff line change
Expand Up @@ -45,37 +45,29 @@ service:

### Configure Tracetest

You also have to configure your Tracetest instance to make it aware that there's no trace data store to pull traces from. Edit your configuration file to include this configuration:
You also have to configure your Tracetest instance to expose an `otlp` endpoint to make it aware it will receive traces from the OpenTelemetry Collector.

### Web UI

In the Web UI, open settings, and select OpenTelemetry Collector.

![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1674644190/Blogposts/Docs/screely-1674644186486_pahrds.png)


### CLI

Or, if you prefer using the CLI, you can use this file config.

```yaml
# tracetest.config.yaml

postgresConnString: "host=postgres user=postgres password=postgres port=5432 sslmode=disable"

poolingConfig:
maxWaitTimeForTrace: 10s
retryDelay: 1s

googleAnalytics:
enabled: true

telemetry:
dataStores:
otlp:
type: otlp
exporters:
collector:
serviceName: tracetest
sampling: 100 # 100%
exporter:
type: collector
collector:
endpoint: otel-collector:4317

server:
telemetry:
dataStore: otlp
exporter: collector
applicationExporter: collector
type: DataStore
spec:
name: Opentelemetry Collector pipeline
type: otlp
isDefault: true
```

Proceed to run this command in the terminal, and specify the file above.

```bash
tracetest datastore apply -f my/data-store/file/location.yaml
```
43 changes: 18 additions & 25 deletions docs/docs/configuration/connecting-to-data-stores/signalfx.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,37 +51,30 @@ service:

You also have to configure your Tracetest instance to make it aware that it has to fetch trace data from SignalFx.

Edit your configuration file to include this configuration:
### Web UI

```yaml
# tracetest.config.yaml

postgresConnString: "host=postgres user=postgres password=postgres port=5432 sslmode=disable"
In the Web UI, open settings, and select SignalFx.

poolingConfig:
maxWaitTimeForTrace: 10m
retryDelay: 5s
![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1674644337/Blogposts/Docs/screely-1674644332529_cks0lw.png)

googleAnalytics:
enabled: true

demo:
enabled: []
### CLI

experimentalFeatures: []
Or, if you prefer using the CLI, you can use this file config.

telemetry:
dataStores:
signalfx:
type: signalfx
signalfx:
token: <YOUR_TOKEN> # UPDATE WITH YOUR TOKEN
realm: <YOUR_REALM> # UPDATE WITH YOUR REALM
```yaml
type: DataStore
spec:
name: SignalFX
type: signalFx
isDefault: true
signalFx:
realm: us1
token: mytoken
```

server:
telemetry:
dataStore: signalfx
exporter: collector
applicationExporter: collector
Proceed to run this command in the terminal, and specify the file above.

```bash
tracetest datastore apply -f my/data-store/file/location.yaml
```

0 comments on commit 11a1c86

Please sign in to comment.