Plugins 〉Chaos Mesh
Chaos Mesh
Data Source
Grafana data source plugin for Chaos Mesh.
This plugin requires Chaos Mesh >=2.1, Grafana >= 10.0.
Note: We only test the plugin on Grafana 10.0.3, it may support lower versions, but we are not sure. Upgrading to Grafana v10 is because of the Angular support deprecation. If you encounter any problems, please open an issue to let us know.
Features
- Displaying Chaos events in a table visualization
- Support Variables to filter Chaos events
- Support Annotations to annotate Chaos events on the panel
Install
With dashboard
https://grafana.com/docs/grafana/latest/administration/plugin-management/#install-a-plugin
With cli
grafana-cli plugins install chaosmeshorg-datasource
Manual installation
Download the plugin zip package with the following command or go to https://github.com/chaos-mesh/datasource/releases to download:
curl -LO https://github.com/chaos-mesh/datasource/releases/download/v3.0.0/chaosmeshorg-datasource-3.0.0.zip
After downloading, unzip:
unzip chaosmeshorg-datasource-3.0.0.zip -d YOUR_PLUGIN_DIR
Then update and save the grafana.ini
file:
[plugins]
allow_loading_unsigned_plugins = chaosmeshorg-datasource
Finally, restart Grafana to load the plugin.
Setup
Once installed, go to Administration -> Data sources and add Chaos Mesh, then go to the configuration page:
Assuming you have Chaos Mesh installed locally, the Chaos Dashboard will export the API on port 2333
by default. So, if you haven't changed anything, you can fill in http://localhost:2333
.
Then use the port-forward
command to activate:
kubectl port-forward -n chaos-testing svc/chaos-dashboard 2333:2333
Finally, click Save & test to test the connection. If it shows a successful notification, the setup is complete.
Query
The data source plugin looks at the Chaos Mesh through the lens of events, and the following options are responsible for filtering the different events:
Object ID
Filter by object uuid.
Namespace
Filter by different namespace.
Name
Filter by object name.
Kind
Filter by kind (PodChaos, NetworkChaos, Schedule...). You can also input an arbitrary kind if you implement a new kind in Chaos Mesh.
Limit
Limit the number of events.
All of them will be passed as parameters to the /api/events
API.
Variables
The data source plugin supports adding query variables by different metrics:
Namespace
After selection, all available namespaces will show in the Preview of values directly.
Kind
Same as Namespace. Retrieve all kinds.
Experiment/Schedule/Workflow
Same as Namespace. Retrieve current all experiments/schedules/workflows.
You can also specify the
queries
to further filter the values, for example,?namespace=default
will only retrieve the experiments/schedules/workflows in thedefault
namespace.
Annotations
You can integrate events into panels via annotations, the following is a sample creation, it will retrieve all PodChaos events:
Please refer to Query to fill in the corresponding fields.
How to contribute
Pull a request or open an issue to describe your changes or problems.
License
Same as Chaos Mesh. Under the Apache-2.0 License.