Cockpit Global API

Scaleway's Observability Cockpit allows you to monitor your applications and their infrastructure by giving you insights and context into their behavior. With Cockpit, you can visualize your resources' and applications' metrics, logs, and traces in Grafana dashboards. Cockpit is automatically activated when you are using Scaleway resources that are integrated into itOpen in new context.

The Global API allows you to perform Cockpit visualization actions such as retrieving your dashboard URLs, managing Grafana users, and synchronizing your data through Grafana dashboards. Refer to the Cockpit APIOpen in new context for data-related management.

(switchcolumn) (switchcolumn)

Concepts

Refer to our dedicated concepts pageOpen in new context to find definitions of the different terms referring to Cockpit.

(switchcolumn) (switchcolumn)

Quickstart

1. Configure your environment variables.

   Note

   This is an optional step that seeks to simplify your usage of the API.

   Code
   export SCW_SECRET_KEY="<API secret key>"
   export SCW_PROJECT_ID="<Scaleway Project ID>"

2. Create a Grafana user with the editor role.

   Code
   curl -X POST \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     -d '{"login":"user-name","role":"editor","project_id":"<Scaleway Project ID>"}' \
     "https://api.scaleway.com/cockpit/v1/grafana/users"

   Note

   The admin username is not available for creation.

   **Your user's password displays in the output. Make sure that you store it securely.**

3. Retrieve a list of available dashboards in Grafana for all Scaleway resources integrated with Cockpit.

   Code
   curl -X GET \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     "https://api.scaleway.com/cockpit/v1/grafana/product-dashboards?project_id=<Scaleway Project ID>"

   The list of available dashboards displays in the output. (switchcolumn)

   Requirement

• You have a Scaleway accountOpen in new context
• You have created an API keyOpen in new context and that the API key has sufficient IAM permissionsOpen in new context to perform the actions described on this page
• You have installed curlOpen in new context
• You have created Scaleway resources integrated with CockpitOpen in new context

(switchcolumn)

Troubleshooting

Refer to our troubleshooting documentation if your pusher does not support HTTP headersOpen in new context or if you want to reset your Grafana password.Open in new context

Technical limitations

• It is not possible to create an admin Grafana user.
• Available roles for Grafana users are viewer and editor.
• The Scaleway preconfigured dashboards cannot be edited.

Going further

For more information about Cockpit, you can check out the following pages:

• Cockpit DocumentationOpen in new context
• Scaleway Slack CommunityOpen in new context join the #observability channel
• Contact our support teamOpen in new context.