Skip to content
Open
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
78 changes: 49 additions & 29 deletions docs/configuration/holmesgpt/toolsets/grafanaloki.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,37 +46,57 @@ fetch the logs and it needs to know the UID of this datasource.

A simple way to get the datasource UID is to access the Grafana API by running the following request:

.. code-block:: bash

# port forward if you are using Robusta's grafana from your kubernetes cluster
kubectl port-forward svc/robusta-grafana 3000:80

# List the loki data sources
curl -s -u <username>:<password> http://localhost:3000/api/datasources | jq '.[] | select(.type == "loki")'
{
"id": 2,
"uid": "klja8hsa-8a9c-4b35-1230-7baab22b02ee",
"orgId": 1,
"name": "Loki-kubernetes",
"type": "loki",
"typeName": "Loki",
"typeLogoUrl": "/public/app/plugins/datasource/loki/img/loki_icon.svg",
"access": "proxy",
"url": "http://loki.loki:3100",
"user": "",
"database": "",
"basicAuth": false,
"isDefault": false,
"jsonData": {
"httpHeaderName1": "admin",
"httpHeaderName2": "X-Scope-OrgID",
"tlsSkipVerify": true
},
"readOnly": false
}
# In this case, there is a single Loki datasourceUID
# with UID "klja8hsa-8a9c-4b35-1230-7baab22b02ee"
.. md-tab-set::

.. md-tab-item:: Self Hosted

.. code-block:: bash

# port forward if you are using Robusta's grafana from your kubernetes cluster
kubectl port-forward svc/robusta-grafana 3000:80

# List the loki data sources
curl -s -u <username>:<password> http://localhost:3000/api/datasources | jq '.[] | select(.type == "loki")'
{
"id": 2,
"uid": "klja8hsa-8a9c-4b35-1230-7baab22b02ee",
"orgId": 1,
"name": "Loki-kubernetes",
"type": "loki",
"typeName": "Loki",
"typeLogoUrl": "/public/app/plugins/datasource/loki/img/loki_icon.svg",
"access": "proxy",
"url": "http://loki.loki:3100",
"user": "",
"database": "",
"basicAuth": false,
"isDefault": false,
"jsonData": {
"httpHeaderName1": "admin",
"httpHeaderName2": "X-Scope-OrgID",
"tlsSkipVerify": true
},
"readOnly": false
}
# In this case, there is a single Loki datasourceUID
# with UID "klja8hsa-8a9c-4b35-1230-7baab22b02ee"



.. md-tab-item:: Grafana Cloud

Choose the datasource you want to use for logs and click on it.

.. image:: /images/grafana-loki-holmes-uid1.png
:width: 600
:align: center

The part of the URL after ``edit/`` is the UID.

.. image:: /images/grafana-loki-holmes-uid2.png
:width: 600
:align: center

Configuration (grafana proxy)
*****************************
Expand Down
73 changes: 46 additions & 27 deletions docs/configuration/holmesgpt/toolsets/grafanatempo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,33 +36,52 @@ fetch the traces and it needs to know the UID of this datasource.

A simple way to get the datasource UID is to access the Grafana API by running the following request:

.. code-block:: bash

# port forward if you are using Robusta's grafana from your kubernetes cluster
kubectl port-forward svc/robusta-grafana 3000:80
# List the Tempo data sources
curl -s -u <username>:<password> http://localhost:3000/api/datasources | jq '.[] | select(.type == "tempo")'
{
"id": 3,
"uid": "klja8hsa-8a9c-4b35-1230-7baab22b02ee",
"orgId": 1,
"name": "Tempo",
"type": "tempo",
"typeName": "Tempo",
"typeLogoUrl": "/public/app/plugins/datasource/tempo/img/tempo_icon.svg",
"access": "proxy",
"url": "http://tempo-query-frontend.tempo:3100",
"user": "",
"database": "",
"basicAuth": false,
"isDefault": false,
"jsonData": {
"tlsSkipVerify": true
},
"readOnly": false
}
# In this case, there is a single Tempo datasourceUID
# with UID "klja8hsa-8a9c-4b35-1230-7baab22b02ee"
.. md-tab-set::

.. md-tab-item:: Self Hosted Tempo

.. code-block:: bash

# port forward if you are using Robusta's grafana from your kubernetes cluster
kubectl port-forward svc/robusta-grafana 3000:80
# List the Tempo data sources
curl -s -u <username>:<password> http://localhost:3000/api/datasources | jq '.[] | select(.type == "tempo")'
{
"id": 3,
"uid": "klja8hsa-8a9c-4b35-1230-7baab22b02ee",
"orgId": 1,
"name": "Tempo",
"type": "tempo",
"typeName": "Tempo",
"typeLogoUrl": "/public/app/plugins/datasource/tempo/img/tempo_icon.svg",
"access": "proxy",
"url": "http://tempo-query-frontend.tempo:3100",
"user": "",
"database": "",
"basicAuth": false,
"isDefault": false,
"jsonData": {
"tlsSkipVerify": true
},
"readOnly": false
}
# In this case, there is a single Tempo datasourceUID
# with UID "klja8hsa-8a9c-4b35-1230-7baab22b02ee"

.. md-tab-item:: Grafana Cloud

Choose the datasource you want to use for Tempo traces and click on it.

.. image :: /images/grafana-tempo-holmes-uid1.png
:width: 600
:align: center
Comment on lines +75 to +77
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

RST build will fail—extra space before “::” in image directives

The directives read .. image ::, but ReStructuredText requires .. image:: (no space). Sphinx will treat these as unknown directives and throw an error.

-    .. image :: /images/grafana-tempo-holmes-uid1.png
+    .. image:: /images/grafana-tempo-holmes-uid1.png

Apply the same fix to the second image block.

Also applies to: 81-83

🤖 Prompt for AI Agents
In docs/configuration/holmesgpt/toolsets/grafanatempo.rst around lines 75 to 77
and also lines 81 to 83, the image directives incorrectly have a space before
the double colon (`.. image ::`). Remove the extra space so the directives read
`.. image::` with no space before the colons to comply with ReStructuredText
syntax and prevent build errors.


The part of the URL after ``edit/`` is the UID.

.. image :: /images/grafana-tempo-holmes-uid2.png
:width: 600
:align: center


Configuration (grafana proxy)
-----------------------------
Expand Down
Binary file added docs/images/grafana-loki-holmes-uid1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-loki-holmes-uid2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-tempo-holmes-uid1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/grafana-tempo-holmes-uid2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading