Skip to content

Commit f5edf84

Browse files
committed
docs(add): add info
1 parent a4f0e2c commit f5edf84

File tree

2 files changed

+17
-24
lines changed

2 files changed

+17
-24
lines changed

pages/cockpit/concepts.mdx

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,10 @@ A Cockpit is an instance of the Observability product that stores metrics, logs,
5656

5757
Contact points define who is notified when an alert fires, according to the region in which you have added them. Contact points include emails, Slack, on-call systems, and texts. When an alert fires, all contact points are notified.
5858

59+
## Custom data
60+
61+
Custom data is any data (metrics, logs or traces) that you may push to Cockpit. It can be data collected from your applications hosted at Scaleway or elsewhere.
62+
5963
## Data sources
6064

6165
Data sources are regionalized backends that allow you to store and fetch your metrics, logs, and traces. By default, **Scaleway data sources** are enabled if you are using [Scaleway resources integrated with Cockpit](/cockpit/reference-content/cockpit-limitations/#product-integration-into-cockpit) on your Project.
@@ -102,14 +106,6 @@ A Grafana user is any individual who can log in to [Grafana](https://grafana.com
102106

103107
Loki is the log aggregation system used by [Grafana](https://grafana.com/docs/grafana/latest/introduction/) to store and query your logs.
104108

105-
## Loki Remote Write
106-
107-
`Loki Remote Write` is the protocol used to push your logs to your Cockpit's logs' endpoint.
108-
109-
## LogQL
110-
111-
LogQL is [Grafana Loki’s language](https://grafana.com/docs/loki/latest/logql/) for querying logs. LogQL uses labels and operators for filtering.
112-
113109
## Logs
114110

115111
Logs are a data type that provides a record of all events and errors taking place during the lifecycle of your resources. They represent an excellent source of visibility if you want to know when a problem occurred, or which events correlate with it.
@@ -142,10 +138,6 @@ A preconfigured dashboard is a set of one or more panels that Scaleway sets up a
142138

143139
`Prometheus Remote Write` is the protocol used to push your metrics to your Cockpit's metrics' endpoint.
144140

145-
## PromQL
146-
147-
PromQL, short for Prometheus Querying Language, is the main way to query metrics within Prometheus. It is designed for building queries for graphs and alerts.
148-
149141
## Receivers
150142

151143
Receivers are hubs consisting of contact points. You can associate one or several alerts with one or more receivers. This allows you to diversify your alerts.
@@ -166,22 +158,27 @@ Retention or data retention refers to the duration for which data, such as metri
166158

167159
The minimum and maximum retention periods for each data source type are as follows:
168160

169-
| Custom metrics | Custom logs/traces | Scaleway metrics | Scaleway logs/traces |
170-
|------------------------------------------------|---------------------------------------------|------------------------------------------------|---------------------------------------------|
171-
| Minimum retention period: 1 day | Minimum retention period: 1 day | Minimum retention period: 31 days | Minimum retention period: 1 day |
172-
| Maximum retention period: 365 days (12 months) | Maximum retention period: 31 days (1 month) | Maximum retention period: 365 days (12 months) | Maximum retention period: 31 days (1 month) |
173-
| Default retention period: 31 days | Default retention period: 7 days | Default retention period: 31 days | Default retention period: 7 days |
161+
| Custom metrics | Custom logs/traces | Scaleway metrics | Scaleway logs/traces |
162+
|------------------------------------------------|----------------------------------------------|------------------------------------------------|-----------------------------------------------|
163+
| Minimum retention period: 1 day | Minimum retention period: 1 day | Minimum retention period: 31 days | Minimum retention period: 1 day |
164+
| Maximum retention period: 1825 days (5 years) | Maximum retention period: 1825 days (5 years)| Maximum retention period: 1825 days (5 years) | Maximum retention period: 1825 days (5 years) |
165+
| Default retention period: 31 days | Default retention period: 7 days | Default retention period: 31 days | Default retention period: 7 days |
174166

175167
## Samples
176168

177169
A sample is a unique measuring point on a time series.
178170

171+
## Scaleway data
172+
173+
Scaleway data is the observability data (metrics and/or logs) that is natively collected by all Scaleway products, integrated with Cockpit.
174+
Refer to the dedicated documentation page to find out which resources are integrated with Cockpit.
175+
179176
## Tempo
180177

181178
Tempo is [Grafana's open source](https://grafana.com/docs/tempo/latest/) tracing tool that allows you to search for traces, generate metrics from them, and link your tracing data with logs and metrics. Tempo can be used with open-source tracing protocols such as [Jaeger](https://www.jaegertracing.io/docs/1.50/), [Zipkin](https://zipkin.io/), and [OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/).
182179

183180
<Message type="important">
184-
During the beta of the traces feature, only the [OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/) HTTP push path is supported. Scaleway is working on implementing the [Open Telemetry gRPC](https://opentelemetry.io/docs/specs/semconv/rpc/grpc/), [Zipkin](https://zipkin.io/) and [Jaeger](https://www.jaegertracing.io/docs/1.50/) protocols.
181+
Only the [OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/) HTTP push path is supported. Scaleway is working on implementing the [Open Telemetry gRPC](https://opentelemetry.io/docs/specs/semconv/rpc/grpc/), [Zipkin](https://zipkin.io/) and [Jaeger](https://www.jaegertracing.io/docs/1.50/) protocols.
185182
</Message>
186183

187184
## Time series
@@ -197,10 +194,6 @@ Tokens are regionalized secret keys that allow you to authenticate against your
197194
- **Rules**: allow you to configure alerting and recording rules.
198195
- **Alerts**: allow you to set up the alert manager.
199196

200-
## TraceQL
201-
202-
[TraceQL](https://grafana.com/docs/tempo/latest/traceql/) is Grafana Tempo's query language designed for searching and extracting traces.
203-
204197
## Traces
205198

206199
Traces are detailed records of your **requests' behavior**, as they move through distributed systems such as microservices and containers.

pages/cockpit/faq.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ meta:
55
content:
66
h1: Cockpit FAQ
77
dates:
8-
validation: 2024-11-25
8+
validation: 2025-03-27
99
category: observability
1010
productIcon: CockpitProductIcon
1111
---
@@ -27,7 +27,7 @@ Refer to the [dedicated documentation page](/cockpit/reference-content/cockpit-l
2727

2828
Using Cockpit with your Scaleway data is free of charge.
2929

30-
During the beta phase of the retention period edition feature, the retention period you set for your data - whether from [Scaleway resources integrated with Cockpit](/cockpit/reference-content/cockpit-limitations/#product-integration-into-cockpit) or custom data - will be free of charge.
30+
The retention period you set for your data - whether from [Scaleway resources integrated with Cockpit](/cockpit/reference-content/cockpit-limitations/#product-integration-into-cockpit) or custom data - will be free of charge.
3131

3232
Additional costs apply for sending custom data to Cockpit. This means that you will be billed for sending **data from Scaleway resources that are not integrated with Cockpit**, or data from any other external resources.
3333

0 commit comments

Comments
 (0)