Skip to content
This repository was archived by the owner on Jul 31, 2025. It is now read-only.

Commit 6edbcb9

Browse files
updated README
1 parent 146b38a commit 6edbcb9

3 files changed

Lines changed: 5 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This software is not affiliated with or supported by CA Technologies.
1010
* Refine the query afterwards with basic regular expressions, e.g. wildcards
1111
* Raw Query Mode: Construct your query manually to leverage all regex features
1212
* Use query-based variables for templating (agents and metrics)
13+
* Aggregate results if your query returns multiple series
1314
* Automatic character escaping, can be disabled
1415

1516
![Demo-Recording](https://github.com/NovaTecConsulting/ca-apm-grafana-datasource/blob/master/media/query-demo.gif)
@@ -38,17 +39,19 @@ When you add a new query for a panel, the query builder mode is used by default.
3839
### Raw Query Mode
3940
Click "Toggle Edit Mode" on the right-hand triple bar menu to switch to raw query mode. Although the query builder mode supports basic regular expressions, you can use the raw query mode to use more advanced regex features. Some regular expressions might require that you disable automatic escaping by toggling the respective checkbox. Additionally, raw query mode supports the aggregation of multiple series into a single aggregated series for display.
4041

42+
__Beware:__ When you switch back to query builder mode, all the changes you made in raw query mode are lost.
43+
4144
### Query Variables
4245
You can create variables for templating based on APM queries. You can either query for agents or metrics. For agents, prepend your agent regex with "Agents|", for metrics use "Metrics|" instead. For example, "Agents|.+" will get you all agents. Use the regex option to transform your query results. See the animation below for an example of an agent query:
4346
![Demo-Recording](https://github.com/NovaTecConsulting/ca-apm-grafana-datasource/blob/master/media/query_variables.gif)
4447

4548
### Temporal Resolution Variable
46-
Considering the different temporal aggregation levels of CA APM, it makes sense to use a template variable to control the temporal resolution of time series data dynamically. Simply create a custom dashboard variable and use `15s,30s,1m,2m,6m,12m,24m,48m,1h,168m,12h` for the values.
49+
Considering the different temporal aggregation levels of CA APM, it makes sense to use a template variable to control the temporal resolution of time series data dynamically. Simply create a dashboard variable of type _Interval_ and use `15s,30s,1m,2m,6m,12m,24m,48m,1h,168m,12h` for the values.
4750

4851
### Series Aggregation
4952
In raw query mode, you can choose an aggregation mode to aggregate multiple metrics into a single series of values. This way, you can get a single aggregated time series for visualization in Grafana if your query returns multiple metrics. The implemented aggregation modes are _sum_, _mean_, _max_, _min_, and _median_. Be careful when your metrics might contain null values - these are not explicitly handled by the aggregation methods.
5053

51-
![Series-Aggregation](https://github.com/NovaTecConsulting/ca-apm-grafana-datasource/blob/master/media/series_aggregation.jpg)
54+
![Series-Aggregation](https://github.com/NovaTecConsulting/ca-apm-grafana-datasource/blob/master/media/multi_series_aggregation.gif)
5255

5356
## License
5457

media/multi_series_aggregation.gif

432 KB
Loading

media/series_aggregation.jpg

-50.6 KB
Binary file not shown.

0 commit comments

Comments
 (0)