Skip to content

Commit 1f49e53

Browse files
authored
Update README.md (#16)
* Update README.md * Update readme + fix broken links
1 parent 69a945e commit 1f49e53

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ The Target Allocator configuration and sample [Python Prometheus app](./src/pyth
2323
This project can be run as a [Development (Dev) Container](https://containers.dev/) in:
2424

2525
* GitHub Codespaces. [Check out this video](https://youtu.be/dRbUKhBtMg4) to learn how.
26-
* VSCode with the [Dev Containers plugin](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). See Step 0 below to learn how.
26+
* VSCode with the [Dev Containers plugin](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). Go to [Step 0](#0--build-and-run-the-dev-container-locally-optional).
2727

28-
Or you could just run all of this sans Dev Containers, if you prefer.
28+
Or, if Dev Containers aren't your jam, then skip [Step 0](#0--build-and-run-the-dev-container-locally-optional) and go straight to [Step 1](#1--install-kind-and-set-up-k8s-cluster).
2929

3030
### 0- Build and run the Dev Container locally (optional)
3131

@@ -71,7 +71,7 @@ Reference [here](https://kind.sigs.k8s.io/docs/user/quick-start/#loading-an-imag
7171

7272
### 3a - Kubernetes Deployment (Collector stdout only)
7373

74-
> 🚨 This step deploys resources to send telemetry to the OTel Collector's sdout only. If you want to send telemetry to [ServiceNow Cloud Observability (formerly known as Lightstep)](https://www.servicenow.com/products/observability.html), you'll need to skip this step and follow [Step 3b](#3b--kubernetes-deployment-servicenow-cloud-observability-backend) instead.
74+
> 🚨 This step deploys resources to send telemetry to the OTel Collector's sdout only. If you want to send telemetry to [Dynatrace](https://dt-url.net/dt-trial) or [ServiceNow Cloud Observability (formerly known as Lightstep)](https://www.servicenow.com/products/observability.html), you'll need to skip this step and follow [Step 3b](#3b--kubernetes-deployment-with-dynatrace-backend) or [Step 3c](#3c--kubernetes-deployment-with-servicenow-cloud-observability-backend), respectively, instead.
7575
7676
Now you are ready to deploy the Kubernetes resources
7777

@@ -81,9 +81,9 @@ Now you are ready to deploy the Kubernetes resources
8181

8282
### 3b- Kubernetes deployment with Dynatrace backend
8383

84-
> 🚨 If you want to send telemetry to [Dynatrace)](https://www.dynatrace.com), you'll need to follow the steps below, and skip [Step 3a](#3a---kubernetes-deployment-collector-stdout-only).
84+
> 🚨 If you want to send telemetry to [Dynatrace)](https://dt-url.net/dt-trial), you'll need to follow the steps below, and skip [Step 3a](#3a---kubernetes-deployment-collector-stdout-only) and [Step 3c](#3c--kubernetes-deployment-with-servicenow-cloud-observability-backend).
8585
86-
To send telemetry to Dynatrace, you will first need a [Dynatrace free trial account](https://www.dynatrace.com/signup/). You will also need to obtain an [access token](https://docs.dynatrace.com/docs/analyze-explore-automate/dynatrace-for-ai-observability/machine-learning-platforms/bedrock#create-a-dynatrace-token).
86+
To send telemetry to Dynatrace, you will first need a [Dynatrace free trial account](https://dt-url.net/dt-trial). You will also need to obtain an [access token](https://adri-v.medium.com/how-do-i-send-opentelemetry-data-to-dynatrace-842cebb21286).
8787

8888
We're going to store the access token in a Kubernetes secret, and will map the secret to an environment variabe in the [`OpenTelemetryCollector CR`](https://github.com/avillela/otel-target-allocator-talk/main/src/resources/02-otel-collector-dt.yml#L17-L21).
8989

@@ -110,7 +110,7 @@ Replace `<base64-encoded-dynatrace-environment-identifier>` with your own enviro
110110
Be sure to Base64 encode it like this:
111111

112112
```bash
113-
echo <LS-access-token> | base64
113+
echo <base64-encoded-dynatrace-token> | base64
114114
```
115115

116116
Or you can Base64-encode it through [this website](https://www.base64encode.org/).
@@ -122,11 +122,11 @@ Finally, deploy the Kubernetes resources:
122122
./src/scripts/04-deploy-resources.sh dt
123123
```
124124

125-
> For more on OTel Collector configuration with Dynatrace, check out [this doc](https://docs.dynatrace.com/docs/ingest-from/opentelemetry/collector/configuration).
125+
> For more on OTel Collector configuration with Dynatrace, check out [this article](https://adri-v.medium.com/how-do-i-send-opentelemetry-data-to-dynatrace-842cebb21286).
126126
127127
### 3c- Kubernetes deployment with ServiceNow Cloud Observability backend
128128

129-
> 🚨 If you want to send telemetry to [ServiceNow Cloud Observability (formerly known as Lightstep)](https://www.servicenow.com/products/observability.html), you'll need to follow the steps below, and skip [Step 3a](#3a---kubernetes-deployment-collector-stdout-only).
129+
> 🚨 If you want to send telemetry to [ServiceNow Cloud Observability (formerly known as Lightstep)](https://www.servicenow.com/products/observability.html), you'll need to follow the steps below, and skip [Step 3a](#3a---kubernetes-deployment-collector-stdout-only) and [Step 3b](#3b--kubernetes-deployment-with-dynatrace-backend).
130130
131131
To send telemetry to ServiceNow Cloud Observability, you will first need a Cloud Observability account. You will also need to obtain an [access token](https://docs.lightstep.com/docs/create-and-manage-access-tokens#create-an-access-token).
132132

0 commit comments

Comments
 (0)