Skip to content

Grafana dashboard doc draft #182

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

Closed
wants to merge 2 commits into from
Closed

Conversation

DifferentialOrange
Copy link
Member

@DifferentialOrange DifferentialOrange commented Feb 1, 2021

Closes tarantool/grafana-dashboard#45

Add documentation section on Grafana dashboard and set up guide.

@@ -194,3 +194,120 @@ via configuration.
format: 'json'

.. _grafana-dashboard:

Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest to move it to it's own page. Separate page is bit more "googlable"

`this page <https://grafana.com/grafana/dashboards/13054>`_ and version for
InfluxDB datasource on `this page <https://grafana.com/grafana/dashboards/12567>`_.
Tarantool Grafana dashboard is a ready for import template with basic memory, space operations
and HTTP load panels, based on default ``metrics`` package functionality.
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest to add reference to metrics docs or github repo

- paste dashboard id (``12567`` for InfluxDB dashboard, ``13054`` for Prometheus dashboard), or
- paste link to dashboard (https://grafana.com/grafana/dashboards/12567 for InfluxDB dashboard,
https://grafana.com/grafana/dashboards/13054 for Prometheus dashboard), or
- paste dashboard json file contents, or
Copy link
Contributor

Choose a reason for hiding this comment

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

is it possible to provide direct link to download json file?

Copy link
Contributor

Choose a reason for hiding this comment

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

It seems to be possible, according to the Sphinx docs (:download: role), but we never tried

Copy link
Member Author

@DifferentialOrange DifferentialOrange Feb 3, 2021

Choose a reason for hiding this comment

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

It is possible (e.g. here https://github.com/tarantool/grafana-dashboard/releases/tag/0.2.2) to make a link to specific revision, but we will need to update it every time I upload a new version.

Copy link
Contributor

@yngvar-antonsson yngvar-antonsson left a comment

Choose a reason for hiding this comment

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

Please add a pic "how Grafana dashboard is look like"

@DifferentialOrange
Copy link
Member Author

Closed in favor of #185 , tarantool/doc#1802 , tarantool/grafana-dashboard#50

@vasiliy-t vasiliy-t deleted the grafana-dashboard-doc branch May 13, 2021 07:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation on tarantool.io
4 participants