Skip to content

Commit 3ff3623

Browse files
committed
docs: Update docs for Monitoring Integrations
1 parent bea9a85 commit 3ff3623

File tree

6 files changed

+29
-32
lines changed

6 files changed

+29
-32
lines changed

docs/pages/product/workspace/monitoring.mdx

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
redirect_from:
3-
- /cloud/workspace/logs
4-
- /monitoring/integrations
5-
---
6-
71
# Monitoring Integrations
82

93
Cube Cloud allows exporting logs and metrics to external monitoring tools so you
@@ -105,13 +99,14 @@ default_api_key = "$CUBE_CLOUD_MONITORING_DATADOG_API_KEY"
10599
### Inputs for logs
106100

107101
Sinks accept the `inputs` option that allows to specify which components of a
108-
Cube Cloud deployment should export their logs. Supported inputs:
102+
Cube Cloud deployment should export their logs:
109103

110-
- `cubejs-server`
111-
- `refresh-scheduler`
112-
- `ext-db`
113-
- `warmup-job`
114-
- `cubestore`
104+
| Input name | Description |
105+
| --- | --- |
106+
| `cubejs-server` | Logs of API instances |
107+
| `refresh-scheduler` | Logs of the refresh worker |
108+
| `warmup-job` | Logs of the [pre-aggregation warm-up][ref-preagg-warmup] |
109+
| `cubestore` | Logs of Cube Store |
115110

116111
Example configuration for exporting logs to
117112
[Datadog][vector-docs-sinks-datadog]:
@@ -122,7 +117,6 @@ type = "datadog_logs"
122117
inputs = [
123118
"cubejs-server",
124119
"refresh-scheduler",
125-
"ext-db",
126120
"warmup-job",
127121
"cubestore"
128122
]
@@ -169,7 +163,6 @@ connection_string = "DefaultEndpointsProtocol=https;AccountName=mylogstorage;Acc
169163
inputs = [
170164
"cubejs-server",
171165
"refresh-scheduler",
172-
"ext-db",
173166
"warmup-job",
174167
"cubestore"
175168
]
@@ -185,20 +178,28 @@ levels = [
185178

186179
### Inputs for metrics
187180

188-
Metrics are exported using the `metrics` input. You can filter them by providing
189-
an array of metric names via the `list` option.
181+
Metrics are exported using the `metrics` input. Metrics will have their respective
182+
metric names and_types: [`gauge`][vector-docs-metrics-gauge] or
183+
[`counter`][vector-docs-metrics-counter].
184+
185+
All metrics of the `counter` type reset to zero at the midnight (UTC) and increment
186+
during the next 24 hours.
187+
188+
You can filter metrics by providing an array of _input names_ via the `list` option.
190189

191-
| Name | Type | Applies to | Description |
192-
| ------------------------ | ---------------------------------------- | -------------------- | ---------------------------------------------- |
193-
| `cpu` | [`gauge`][vector-docs-metrics-gauge] | Node of a deployment | Percent of free CPU against requests |
194-
| `memory` | [`gauge`][vector-docs-metrics-gauge] | Node of a deployment | Percent of free Memory against requests |
195-
| `requests-count` | [`counter`][vector-docs-metrics-counter] | Deployment | Total number of processed requests |
196-
| `requests-errors-count` | [`counter`][vector-docs-metrics-counter] | Deployment | Number of requests processed with errors |
197-
| `requests-success-count` | [`counter`][vector-docs-metrics-counter] | Deployment | Number of requests processed successfully |
198-
| `requests-duration` | [`counter`][vector-docs-metrics-counter] | Deployment | Total time taken to process requests (seconds) |
190+
| Input name | Metric name, type | Description |
191+
| --- | --- | --- |
192+
| `cpu` | `cube_cpu_usage_ratio`, `gauge` | CPU usage of a particular node in the deployment. Usually, a number in the 0—100 range. May exceed 100 if the node is under load |
193+
| `memory` | `cube_memory_usage_ratio`, `gauge` | Memory usage of a particular node in the deployment. Usually, a number in the 0—100 range. May exceed 100 if the node is under load |
194+
| `requests-count` | `cube_requests_total`, `counter` | Number of API requests to the deployment |
195+
| `requests-success-count` | `cube_requests_success_total`, `counter` | Number of successful API requests to the deployment |
196+
| `requests-errors-count` | `cube_requests_errors_total`, `counter` | Number of errorneous API requests to the deployment |
197+
| `requests-duration` | `cube_requests_duration_ms_total`, `counter` | Total time taken to process API requests, milliseconds |
198+
| `requests-success-duration` | `cube_requests_duration_ms_success`, `counter` | Total time taken to process successful API requests, milliseconds |
199+
| `requests-errors-duration` | `cube_requests_duration_ms_errors`, `counter` | Total time taken to process errorneous API requests, milliseconds |
199200

200-
You can further filter exported metrics by providing an array of `inputs` that
201-
applies to metics only.
201+
You can further filter exported metrics by providing an array of `inputs`. It applies to
202+
metics only.
202203

203204
Example configuration for exporting all metrics from `cubejs-server` to
204205
[Prometheus][vector-docs-sinks-prometheus] using the `prometheus_remote_write`
@@ -300,4 +301,5 @@ setting `CUBE_CLOUD_MONITORING_METRICS_USER` and
300301
[prometheus]: https://prometheus.io
301302
[mimir]: https://grafana.com/oss/mimir/
302303
[grafana-cloud]: https://grafana.com/products/cloud/
303-
[ref-prod-env]: /product/workspace/environments#production-environment
304+
[ref-prod-env]: /product/workspace/environments#production-environment
305+
[ref-preagg-warmup]: /product/deployment/cloud/warm-up#pre-aggregation-warm-up

docs/pages/product/workspace/monitoring/cloudwatch.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ type = "aws_cloudwatch_logs"
2727
inputs = [
2828
"cubejs-server",
2929
"refresh-scheduler",
30-
"ext-db",
3130
"warmup-job",
3231
"cubestore"
3332
]

docs/pages/product/workspace/monitoring/datadog.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ type = "datadog_logs"
3131
inputs = [
3232
"cubejs-server",
3333
"refresh-scheduler",
34-
"ext-db",
3534
"warmup-job",
3635
"cubestore"
3736
]

docs/pages/product/workspace/monitoring/grafana-cloud.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ type = "loki"
3131
inputs = [
3232
"cubejs-server",
3333
"refresh-scheduler",
34-
"ext-db",
3534
"warmup-job",
3635
"cubestore"
3736
]

docs/pages/product/workspace/monitoring/new-relic.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ api = "logs"
2525
inputs = [
2626
"cubejs-server",
2727
"refresh-scheduler",
28-
"ext-db",
2928
"warmup-job",
3029
"cubestore"
3130
]

docs/pages/product/workspace/monitoring/s3.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ type = "aws_s3"
2323
inputs = [
2424
"cubejs-server",
2525
"refresh-scheduler",
26-
"ext-db",
2726
"warmup-job",
2827
"cubestore"
2928
]

0 commit comments

Comments
 (0)