ContextQMD
Back to Devops Exercises

README

topics/grafana/README.md

latest8.7 KB
Original Source

Grafana

<details> <summary>Explain what is Grafana</summary> <b>

Grafana Docs: "Grafana is a complete observability stack that allows you to monitor and analyze metrics, logs and traces. It allows you to query, visualize, alert on and understand your data no matter where it is stored. Create, explore, and share beautiful dashboards with your team and foster a data driven culture." </b></details>

<details> <summary>What is Grafana Cloud?</summary> <b>

Grafana cloud is an edition of Grafana that is offered as a service through the cloud. The observabilty stack is set up, administered and maintained by Grafana Labs and offers both free and paid options. You can also send data from existing data sources e.g. Promethetus, Loki and visualise existing time series data. </b></details>

<details> <summary>What is Grafana Enterprise?</summary> <b>

Grafana Enterprise is a commercial edition of Grafana offered with enterprise features such as Enterprise datasource plugins and built-in collaboration features. The edition includes full-time support and training from the Grafana team. </b></details>

<details> <summary>What is the default HTTP port of Grafana?</summary> <b>

Grafana getting started: Grafana runs on port 3000 by default. </b></details>

<details> <summary>Explain how we can enforce HTTPS</summary> <b>

Grafana community: Set the protocol to https on the Configuration settings, Grafana will then expect clients to send requests using the HTTPS protocol. Any client that uses HTTP will receive an SSL/TLS error. </b></details>

<details> <summary>How can we install plugins for Grafana?</summary> <b>

Grafana getting started: Navigate to the Grafana plugins page, find the desired plugin and click on it, then click the installation tab. There are two ways to install depending on where your Grafana server is running:

  • Cloud: On the For field of the installation tab, select the name of the organization you want to install the plugin on (unless you are only part of one), then click install plugin. Grafana cloud will automatically install the plugin to your Grafana instance, you may need to log out and back in to see the plugin.
  • Local grafana: You can use the Grafana CLI which lets you list available plugins and install them.
grafana-cli plugins list-remote
grafana-cli plugins install <plugin-id>

You can also install a packaged plugin by downloading the asset from the installation tab, then extract the archive into the plugin directory. The path to the plugin directory can be seen in the configuration file

unzip my-plugin-0.2.0.zip -d YOUR_PLUGIN_DIR/my-plugin

</b></details>

<details> <summary>Explain what a 'Data source' is</summary> <b>

Grafana Docs: A data source is a storage backend that acts as a source of data for Grafana. Some popular data sources are Prometheus, InfluxDB, Loki, AWS cloudwatch. </b></details>

<details> <summary>What is the "Default configuration"?</summary> <b>

Grafana docs: The default configuration contains settings that Grafana use by default. The location depends on the OS environment, note that $WORKING_DIR refers to the working directory of Grafana.

  • Windows: $WORKING_DIR/conf/defaults.ini
  • Linux: /etc/grafana/grafana.ini
  • macOS: /usr/local/etc/grafana/grafana.ini </b></details>
<details> <summary>Explain how we can add Custom configuration to Grafana</summary> <b>

Grafana docs: The custom configuration can be configured, either by modifying the custom configuration file or by adding environment variables that overrides default configuration. The configuration varies depending on the OS:

  • Windows: There is a file sample.ini in the same directory as the defaults.ini file, copy sample.ini and name it custom.ini. Uncomment the settings you want to override.
  • Linux: Edit the configuration file at /etc/grafana/grafana.ini
  • macOS: Add a configuration file named custom.ini in the conf folder, if you installed Grafana using Homebrew then you can manually edit the conf/defaults.ini
  • Docker: You can override existing configuration in Grafana with environmental variables. An example is setting the Grafana instance name: E.g. export GF_DEFAULT_INSTANCE_NAME=my-instance </b></details>
<details> <summary>Which external authentication is supported out-of-the-box?</summary> <b>

Grafana docs: Grafana Auth is the built-in authentication system with password authentication enabled by default. </b></details>

<details> <summary>How can we import a dashboard to a Grafana instance?</summary> <b>

Grafana getting started: Grafana dashboards can be imported through the Grafana UI. Click on the + icon in the sidebar and then click import. You can import a dashboard through the following options:

  • Uploading a dashboard JSON file, which is exported from the Grafana UI or fetched through the HTTPS API
  • Paste a Grafana dashboard URL which is found at grafana Dashboards, or a dashboard unique id into the text area.
  • Paste raw Dashboard JSON text into the panel area. Click load afterwards. </b></details>
<details> <summary>What is the data format for the dashboard?</summary> <b>

Grafana docs: Grafana dashboards are represented in JSON files as objects, they store metadata about a dashboard e.g. dashboard properties, panel metadata and variables.

</b></details>

<details> <summary>Explain the steps to share your dashboard with your team</summary> <b>

Grafana docs: Go to the homepage of your grafana Instance. Click on the share icon in the top navigation, from there three tabs are visible with the link tab shown.

  • Direct link: Click copy, send the link to a Grafana user, note that the user needs authorization to view the link. This is done by adding the user to a team.
  • Public Snapshot: Click on local snapshot to publish a snapshot to your local Grafana instance, or Publish to snapshots.raintank.io which is a free service for publishing dashboard snapshots to an external Grafana instance You can configure snapshots to expire after a certain time and the timeout value to collect dashboard metrics </b></details>
<details> <summary>How can you organise your dashboards and users in Grafana?</summary> <b>

Grafana docs: The recommended way by Grafana labs is to create Folders for grouping dashboards, library panels and alerts. Users can be organised through Teams which grants permissions to members of a group.

  • Folders: Click the + icon in the sidebar, then click "Create folder". In the create folder page, fill an unique name for the folder and click "Create"
  • Teams You need to be the server admin in order to create Teams.
  1. Click the server admin (shield) icon in the sidebar, then in the Users tab, click New user.
  2. Enter the user details e.g. name, E-mail, Username and Password. The password can be changed later by the user
  3. Click Create to create the user account. </b></details>
<details> <summary>Explain the steps to create an 'Alert'</summary> <b>

Grafana docs:

"Navigate to the panel you want to add or edit an alert rule for, click the title, and then click Edit. On the Alert tab, click Create Alert. If an alert already exists for this panel, then you can just edit the fields on the Alert tab. Fill out the fields. Descriptions are listed below in Alert rule fields. When you have finished writing your rule, click Save in the upper right corner to save alert rule and the dashboard. (Optional but recommended) Click Test rule to make sure the rule returns the results you expect" </b></details>