Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/novatecconsulting/ca-apm-grafana-datasource

CA APM (fka Wily Introscope) Data Source Plugin for Grafana
https://github.com/novatecconsulting/ca-apm-grafana-datasource

apm grafana grafana-datasource introscope metrics metrics-visualization monitoring performance-management performance-metrics performance-monitoring

Last synced: about 1 month ago
JSON representation

CA APM (fka Wily Introscope) Data Source Plugin for Grafana

Host: GitHub
URL: https://github.com/novatecconsulting/ca-apm-grafana-datasource
Owner: NovatecConsulting
License: mit
Created: 2018-01-26T08:12:11.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2024-06-11T09:06:38.000Z (6 months ago)
Last Synced: 2024-07-30T16:57:08.309Z (5 months ago)
Topics: apm, grafana, grafana-datasource, introscope, metrics, metrics-visualization, monitoring, performance-management, performance-metrics, performance-monitoring
Language: TypeScript
Homepage:
Size: 4.83 MB
Stars: 17
Watchers: 11
Forks: 9
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# CA APM Grafana Data Source

CA APM data source for Grafana, based on the [Metrics Data Web Service (SOAP)](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/ca-enterprise-software/it-operations-management/application-performance-management/10-7/api-reference/ca-introscope-web-services-api-reference/polling-web-services/metrics-data-web-service.html)

This software is not affiliated with or supported by CA Technologies.

## Features
* Visualize CA APM (fka Introscope) metrics in Grafana dashboards (time series format)
* Query Builder: Browse available metrics to construct a metric query
* Refine the query afterwards with basic regular expressions, e.g. wildcards
* Raw Query Mode: Construct your query manually to leverage all regex features
* Use query-based variables for templating (agents and metrics)
* Aggregate results if your query returns multiple series
* Automatic character escaping, can be disabled

![Demo-Recording](https://github.com/NovaTecConsulting/ca-apm-grafana-datasource/blob/master/media/query-demo.gif)

Just copy the contents of this repository to the plugin directory of your Grafana installation. Assuming the default data path, you should end up with `/var/lib/grafana/plugins/ca-apm-datasource` (Linux) or `/data/plugins/ca-apm-datasource` (Windows) for example. Only the dist directory is required.

If you use Docker you can just mount the appropriate path. For example:
```
docker run \
-d \
--name=grafana \
-p 3000:3000 \
-v :/var/lib/grafana/plugins/ca-apm-datasource \
grafana/grafana
```

## Data Source Configuration
To configure a CA APM data source in Grafana, you just have to provide the APM Enterprise Manager's API endpoint and proper authentication details (HTTP basic authentication). The specified user must be authorized to use the Metrics Data Web Service. Click "Save & Test" to make sure that your configuration works correctly.

![Data Source Config](https://github.com/NovaTecConsulting/ca-apm-grafana-datasource/blob/master/media/data-source-config.jpg)

## Metric Queries
To construct a metric query, first create a new panel on a dashboard and select a CA APM data source.
### Query Builder
When you add a new query for a panel, the query builder mode is used by default. Simply click the respective buttons to browse and select agent, metric, and data frequency for your query.
### Raw Query Mode
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.

__Beware:__ When you switch back to query builder mode, all the changes you made in raw query mode are lost.

### Query Variables
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:
![Demo-Recording](https://github.com/NovaTecConsulting/ca-apm-grafana-datasource/blob/master/media/query_variables.gif)

### Temporal Resolution Variable
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.

### Series Aggregation
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_.

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

## License

Licensed under the [MIT](LICENSE.md) License.

## Issues, Feedback and Support
If you experience any issues, have some feedback, or are interested in support, contact us here on GitHub or via email at [email protected].