Skip to content

Clarify endpoint on README.md #71

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.

Sign up for GitHub

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

Open
juliafmorgado wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify endpoint on README.md #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ To setup the web sdk you'll need the following:

2. Retrieve the following information from your Dash0 account:

- `endpoint` URL for your Dash0 region ([Dash0 link](https://app.dash0.com/settings/endpoints))
- The OTLP via HTTP `endpoint` URL for your Dash0 region ([Dash0 link](https://app.dash0.com/settings/endpoints))

- `authToken` with `Ingesting` permissions for the dataset ([Dash0 link](https://app.dash0.com/settings/auth-tokens))
- The `authToken` with `Ingesting` permissions for the dataset ([Dash0 link](https://app.dash0.com/settings/auth-tokens))
- Auth tokens for client monitoring will be public as part of your website, please make sure to:
- Use a separate token, exclusively for website monitoring; if you want to monitor multiple websites, it is best to use a dedicated token for each
- Limit the dataset permissions on the auth token to the dataset you want to ingest Website Monitoring data with
Expand Down Expand Up @@ -51,7 +51,7 @@ init({
serviceName: "my-website",
endpoint: {
// Replace this with the endpoint URL for your Dash0 region, that you retrieved earlier in "prerequisites"
url: "{endpoint}",
url: "{OTLP via HTTP endpoint}",
// Replace this with your auth token you retrieved earlier in "prerequisites"
// Ideally, you will inject the value at build time in order not commit the token to git,
// even if its effectively public in the HTML you ship to the end user's browser
Expand Down