Jump toUpdate content

Cockpit - Quickstart

Published on 31 October 2022

Scaleway Observability allows you to monitor your applications and their infrastructure by giving you insights and context into their behavior. Observability also enables you to visualize your metrics and logs through a Grafana dashboard.

The Observability Cockpit provides you with 2 Remote Write endpoints to be able to push metrics and logs. You can push metrics with any Prometheus Remote Write compatible agent such as the Prometheus, Grafana or OpenTelemetry Collector agents. You can push logs with any Loki compatible agent such as the Promtail, Fluentd, Fluent Bit or Logstash agents.

In this Quickstart, we show you how to activate your Cockpit, how to retrieve your Grafana credentials, how to create a push token and how to send metrics and logs to your Cockpit.

Identity and Access Management (IAM):

If you have activated IAM, you may need certain IAM permissions to carry out some actions described on this page. This means:

  • you are the Owner of the Scaleway Organization in which the actions will be carried out, or
  • you are an IAM user of the Organization, with a policy granting you the necessary permission sets
Requirements:

You have an account and are logged into the Scaleway console

How to activate your Cockpit

  1. Click Cockpit in the Observability section of the console side menu. The Cockpit overview page displays.
  2. Click Activate to activate your Cockpit. Your Cockpit will be ready in a matter of minutes.

How to retrieve your Grafana credentials

  1. Click Cockpit in the Observability section of the console side menu. The Cockpit overview page displays.
  2. Click the Grafana Users tab.
  3. Click Add a user.
  4. Enter a username.
  5. Select a role for the user.
  6. Click Add a user. Your automatically-generated password displays. Make sure to copy and save it before closing the pop-up.

How to create a token to push your metrics and logs

  1. Click Cockpit in the Observability section of the console side menu. The Cockpit overview page displays.

  2. Click the Tokens tab.

  3. Click Generate new token to create a token. A pop-up displays prompting you to create a token.

  4. Choose a name for your token or use the already-generated name.

  5. Select the Push permission for metrics and logs. This permission allows you to send your metrics and logs to your Cockpit.

  6. Click Generate token to generate your token. A pop-up displays with your secret key.

    Important:

    Make sure to save your secret key before closing the pop-up.

Your newly-created token displays in the list of your tokens.

How to send your metrics and logs to your Cockpit

  1. Click Cockpit in the Observability section of the console side menu. The Cockpit overview page displays.

  2. Configure your applications to send metrics and logs to your Cockpit endpoints, using the token you have created above for authentication.

    Important:
    • The Prometheus Remote Write endpoint to push your metrics is the following: https://metrics.prd.obs.fr-par.scw.cloud/api/v1/push
    • The Remote Write endpoint to push your logs is the following: https://logs.prd.obs.fr-par.scw.cloud/loki/api/v1/push
  3. Click Open your dashboard to open your Grafana managed dashboard. You are redirected to the Grafana website.

  4. Enter the credentials you have previously generated.

  5. Click Log in. The Grafana overview page displays.

  6. Hover over Dashboards and click Browse.

  7. Click the folder icon. The Scaleway folder displays.

  8. Click the Scaleway folder to display Scaleway’s managed dashboards.