Plugins 〉OData


Developer

d.velop AG

Sign up to receive occasional product news and updates:


Grafana Cloud
Grafana Cloud
  • Grafana, of course
  • 10k series Prometheus metrics
  • 50 GB logs
  • 50 GB traces
  • 2,232 app o11y host hours
  • ...and more
Create free account

No credit card needed, ever.


Data Source
community

OData

  • Overview
  • Installation
  • Change log
  • Related content

Grafana OData Data Source

Visualize data from OData data sources with Grafana.

About

This is a Grafana data source for showing data from OData V4 compliant data sources.

It was originally developed for internal purposes and is now made available to the open source community.

Getting started

Open Grafana and go to Configuration / Data Sources. Click Add data source button.

Enter OData into the filter input field and select the OData Data Source.

Add Data Source

Provide the URL of your OData Service Root and click Save & test to test the connection.

The URL space encoding setting can be used to specify the encoding of spaces in URLs. Percent uses %20 (see RFC 3986), while Plus uses + (used in form data). E.g. $filter=value%20EQ%201 vs. $filter=value+EQ+1.

Add other connection settings, such as auth settings, as necessary.

To use the data source, create a new query and select the newly created OData data source.

CreateQuery.png

Choose an entity set, an appropriate time property, and the metric you want to view. Now you should be able to see data for the selected time frame.

Related Links

  • Grafana - the open source analytics & monitoring solution for many data sources
  • Build a Grafana data source plugin - a tutorial that explains how to develop your own data source plugin.
  • OData - the ISO/IEC approved, OASIS standard for building and using data-driven RESTful APIs

Contributing

This project is maintained by d-velop but is looking for contributors. If you consider contributing to this project please read CONTRIBUTING and DEVELOPING for details on how to get started.

License

Please read LICENSE for licensing information.

Installing OData on Grafana Cloud:

For more information, visit the docs on plugin installation.

Installing on a local Grafana:

For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.

1. Install the Data Source

Use the grafana-cli tool to install OData from the commandline:

grafana-cli plugins install 

The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.

2. Configure the Data Source

Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.

Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.

To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.

Change Log

[1.1.0] 2024-03-14

Features

  • #2: Made time property optional
  • Updated to go version 1.21
  • Updated to Grafana 10.2
  • Configurable space encoding (%20or +)

[1.0.0] 2023-05-12

Features

  • Initial revision