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

Changed markdown image tag to Frame (#649) #650

Merged
merged 2 commits into from
Oct 18, 2023
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
4 changes: 3 additions & 1 deletion docs/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@ The different microservices communicate via Kubernetes API server (see

The following diagram shows the architecture of the Odigos observability system.

![Odigos Architecture](/images/Odigos_Arch.jpeg)
<Frame>
<img src="/images/Odigos_Arch.jpeg" alt="Odigos Architecture" />
</Frame>

## Instrumentor

Expand Down
9 changes: 7 additions & 2 deletions docs/backends/datadog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,16 @@ title: "Datadog"
## Obtaining an API Key

On the left sidebar, click on your username and then click on **Organization Settings**
![](/backends/images/datadog1.png)

<Frame>
<img src="/backends/images/datadog1.png" alt="Organization settings menu" />
</Frame>

Click on **API Keys** and then click on **New Key** and give it a name.

![](/backends/images/datadog2.png)
<Frame>
<img src="/backends/images/datadog2.png" alt="New API key screen" />
</Frame>

## Configuring the Datadog Backend

Expand Down
20 changes: 16 additions & 4 deletions docs/backends/grafanacloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,18 @@ title: "Grafana Cloud"
Currently, Odigos supports Grafana Cloud as a three data source types: Prometheus, Loki, and Tempo.

All the connection details can be found at [grafana.com](grafana.com) under **My Account**
![](/backends/images/grafanacloud1.png)

<Frame>
<img src="/backends/images/grafanacloud1.png" alt="Grafana labs website" />
</Frame>

## Configuring Grafana Cloud managed Loki

Press **Details** under the Loki data source
![](/backends/images/grafanacloud2.png)

<Frame>
<img src="/backends/images/grafanacloud2.png" alt="Loki logging service setup" />
</Frame>

Enter the following settings into Odigos UI:

Expand All @@ -21,7 +27,10 @@ Enter the following settings into Odigos UI:
## Configuring Grafana Cloud managed Prometheus

Press **Details** under the Prometheus data source
![](/backends/images/grafanacloud3.png)

<Frame>
<img src="/backends/images/grafanacloud3.png" alt="Prometheus monitoring service setup" />
</Frame>

Insert into Odigos the following settings:

Expand All @@ -32,7 +41,10 @@ Insert into Odigos the following settings:
## Configuring Grafana Cloud managed Tempo

Press **Details** under the Tempo data source
![](/backends/images/grafanacloud4.png)

<Frame>
<img src="/backends/images/grafanacloud4.png" alt="Tempo tracing service setup" />
</Frame>

Insert into Odigos the following settings:

Expand Down
5 changes: 4 additions & 1 deletion docs/backends/honeycomb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ title: "Honeycomb"
[Click here](https://ui.honeycomb.io/odigos/environments/test/api_keys) to go to Honeycomb API Keys page and click on **Create API Key**

Make sure the API Key is permitted to **Send Events** to Honeycomb.
![](/backends/images/honeycomb.png)

<Frame>
<img src="/backends/images/honeycomb.png" alt="API Keys settings page in Honeycomb" />
</Frame>

## Configuring Honeycomb Backend

Expand Down
8 changes: 6 additions & 2 deletions docs/backends/newrelic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@ title: "New Relic"

On the left sidebar, click on your account name and select **API Keys** and then click on **Create a key**.

![](/backends/images/newrelic1.png)
<Frame>
<img src="/backends/images/newrelic1.png" alt="New Relic API keys" />
</Frame>

For key type select **Ingest - License**, give a name to your key and press **Create a key**.

![](/backends/images/newrelic2.png)
<Frame>
<img src="/backends/images/newrelic2.png" alt="Create an API key screen in New Relic" />
</Frame>

## Configuring New Relic Backend

Expand Down
10 changes: 8 additions & 2 deletions docs/backends/splunk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,16 @@ title: "Splunk"
## Obtaining Access Token

Go to **Settings** then **Access Tokens**. and click **Create New Token**
![](/backends/images/splunk1.png)

<Frame>
<img src="/backends/images/splunk1.png" alt="Splunk Access Tokens menu" />
</Frame>

Give the token a name and select **Ingest Token** for the authorization scope and click create.
![](/backends/images/splunk2.png)

<Frame>
<img src="/backends/images/splunk2.png" alt="Create Access Token form in Splunk" />
</Frame>

## Configuring the Splunk Backend

Expand Down
8 changes: 6 additions & 2 deletions docs/instrumenting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ sidebarTitle: "Generating Traces"

You should now see the following page:

![Select target applications](/images/choose_apps.png)
<Frame>
<img src="/images/choose_apps.png" alt="Select target applications" />
</Frame>

Select all the applications in the `default` namespace and click `Next`.
<Note>
Expand All @@ -20,7 +22,9 @@ Selecting **Apply for future apps** will automatically generate distributed trac
In the next step, you will be asked to select a destination for your traces.
Scroll down to the self hosted destinations and click on **Jaeger**.

![Select Jaeger](/images/choose_jaeger.png)
<Frame>
<img src="/images/choose_jaeger.png" alt="Select Jaeger" />
</Frame>

#### Connection details

Expand Down