CLP Datasource Plugin for Grafana

A Grafana datasource plugin for querying and visualizing log data from a CLP API server.

Requirements

• Node.js >= 22
• Docker (for running the local Grafana instance)
• A running CLP instance

Getting started

Start the plugin and a dedicated Grafana deployment

Install the dependencies:

npm clean-install

Build the plugin and start the server:

npm run build
npm run server

Usage

1. By default, Grafana listens to 0.0.0.0:3000. Open http://<GRAFANA_IP>:3000 in the browser.

2. Connect the datasource to a CLP API server:

   • Navigate to Connections > Data sources > CLP on the left side panel.
   • Enter the API server URL (e.g., http://<CLP_API_SERVER_HOST>:<PORT>).
   • Click Save & test to verify connectivity.

3. Explore log data:

   • Click Explore on the left side panel.
   • Configure your query in the query editor:
     • Dataset: the dataset to search (defaults to default).
     • Query Text: the search query string.
     • Ignore Case: whether to perform a case-insensitive search.
     • Max Results: the maximum number of results to return.
   • Set the desired time range and click Run query in the top right.
   • The results will be displayed.

4. Build a dashboard:

   • Add a visualization and choose CLP as the datasource.
   • Configure your query in the query editor.
   • Set the desired time range and click Refresh to run the query.
   • To view results in the Logs panel, select the Logs visualization in the top right.
   • To enable Grafana log level detection:
     1. Add an Extract fields transformation and choose JSON as the format.
     2. Extract the JSON field path for the log level into a field named severity.

Test the plugin in an existing Grafana deployment

1. Clone the repo into the Grafana plugins directory (usually /usr/share/grafana/public/app/plugins/datasource/).

2. Restart Grafana. You should then be able to set up a new CLP datasource.