diff options
author | DShreve2 <david@netdata.cloud> | 2022-09-30 10:51:00 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-30 10:51:00 -0400 |
commit | 74fc4831bfcee8b87f194b54adc2a9245e207a86 (patch) | |
tree | 5a4eda4eb92276a5330895713d90d8eba81a355d /docs | |
parent | 0e2033c743163f9b1193666a8d7e04e28ea2fc2d (diff) |
Provide Details on Label Filtering/Custom Labels (#13745)
* Provide Details on Label Filtering/Custom Labels
Adding documentation for the new Chart Label Filtering feature and custom labels for collectors.
* Add screenshots to label filtering
* Update docs/dashboard/interact-charts.mdx
Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com>
Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dashboard/interact-charts.mdx | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/dashboard/interact-charts.mdx b/docs/dashboard/interact-charts.mdx index 5633bd080e..fe0f05e3f7 100644 --- a/docs/dashboard/interact-charts.mdx +++ b/docs/dashboard/interact-charts.mdx @@ -117,6 +117,63 @@ the resolution to `resolution 1 sec` to see the exact values. Many of the above interactions can also be triggered using the icons on the bottom-right corner of every chart. They are, respectively, `Pan Left`, `Reset`, `Pan Right`, `Zoom In`, and `Zoom Out`. +## Chart label filtering + +The chart label filtering feature supports grouping by and filtering each chart based on labels (key/value pairs) applicable to the context and provides fine-grain capability on slicing the data and metrics. + +All metrics collected get "tagged" with labels and values, thus providing a powerful way of slicing and visualizing all metrics related to the infrastructure. + +The chart label filtering is currently enabled on: + +- All charts on the **Overview** tab +- Custom dashboards + +![Chart filtering on Overview tab chart](https://user-images.githubusercontent.com/88642300/193084084-01074495-c826-4519-a09f-d210f7e3e6be.png) +![Chart filtering on Custom dashboard](https://user-images.githubusercontent.com/88642300/193084172-358dfded-c318-4d9f-b6e2-46a8fc33030b.png) + +The top panel on each chart displays the various filters and grouping options selected on the specific chart. These filters are specific for each chart and need to be manually configured on each chart. + +Additionally, the charts can be saved to a custom dashboard, new or existing, with the selected filters from the overview screen. + +![Chart filtering saved on custom dashboard](https://user-images.githubusercontent.com/88642300/193084225-1b65984e-566c-4815-8bc1-a2781d3564bd.png) + +## Custom labels for Collectors + +In addition to the default labels associated with a collector and metrics context (you can identify them by seeing which ones have an underscore as a prefix), there is now a new feature enabled to create custom labels. These custom labels may be needed to group your jobs or instances into various categories. + +These custom labels can be configured within your go.d plugins by simply associating a label key/value pair, as in the following eaxmple. + +```conf +jobs: + - name: example_1 + someOption: someValue + labels: + label1: value1 + label2: value2 + - name: example_2 + someOption: someValue + labels: + label3: value3 + label4: value4 +``` + +For instance, you may be running multiple Postgres database instances within an infrastructure. Some of these may be associated with testing environments, some with staging and some with production environments. You can now associate each Postgres job / instance with a custom label. The “group by” and filtering options will then allow you to associate individual jobs by specific labels. + +```conf +jobs: + - name: local + dsn: 'postgres://postgres:postgres@127.0.0.1:5432/postgres' + collect_databases_matching: '*' + labels: + instance_type: production + ``` + ![Group by individual job labels one](https://user-images.githubusercontent.com/88642300/193084580-49df500a-ddfb-45bb-a209-3c7a904ee9e0.png) + ![group by individual job labels two](https://user-images.githubusercontent.com/88642300/193084624-6d9848d0-9400-4e34-9cd4-78e50c784cc0.png) + +### Future Work + +We already have [configurable host labels](https://learn.netdata.cloud/guides/using-host-labels) as well, which currently can’t be used to filter or group your metrics. We intend to provide the same capabilities described here with host labels, among other capabilities on other areas of the app as well + ## What's next? We recommend you read up on the differences between [chart dimensions, contexts, and |