Monitoring a production environment of any system requires inspecting many statistics.
- History - Since statistics are polled and aggregated at runtime in memory, they're limited to a few minutes of history, whereas in production users often need to store metrics for a few days at least.
- Persistency - If the web server goes down, all statistics are lost.
- Scalability - The web server gathers statistics by polling each component. This approach is not scalable, and does not behave well on large clusters.
To overcome these limitations, GigaSpaces also provides a powerful and versatile framework for reporting metrics. Each component can report its own predefined or user-defined metrics to any database or tool by implementing a metrics reporter. In addition, GigaSpaces provides a built-in reporter for InfluxDB and integration with Grafana to provide metrics storage and visualization:
- InfluxDB is an open-source distributed time-series database with a powerful query language.
- Grafana is an enterprise tool for organizations with a graph and dashboard builder for visualizing time-series metrics, which supports InfluxDB (and other data sources).
When these metrics are enabled, GigaSpaces reports them to InfluxDB, and the Web Management Console provides an embedded Grafana view in the Monitoring tab, as well as automatic creation of dashboards in Grafana whenever a new Processing Unit is deployed.
InfluxDB and Grafana are both open-source and free, but are not bundled in GigaSpaces distribution. Installation is straightforward, as described below. Note that GigaSpaces's default metrics configuration is set to match the default settings of InfluxDB and Grafana, so if this is your first time we recommend leaving the default configuration to simplify the process.
To configure InfluxDB, edit the metrics.xml file, found under
$GS_HOME/charts/xap-manager/config for Kubernetes, and under
$GS_HOME/config/metrics for ServiceGrid. Change the following part according to your InfluxDB host (myhost) and database name (mydb) that stores metrics:
<grafana> <datasources> <datasource name="influxdb"> <property name="type" value="influxdb"/> <property name="url" value="http://myhost:8086/db/mydb"/> <property name="username" value="root"/> <property name="password" value="root"/> </datasource> <datasource name="grafana"> <property name="type" value="influxdb"/> <property name="url" value="http://myhost:8086/db/grafana"/> <property name="username" value="root"/> <property name="password" value="root"/> <property name="grafanaDB" value="true"/> </datasource> </datasources> </grafana>
After installation, you need to configure Grafana to work with GigaSpaces's metrics configuration, which is located at
$GS_HOME/charts/xap-manager/config/metrics.xml for Kubernetes, and at
$GS_HOME/config/metrics/metrics.xml for ServiceGrid. Assuming you've installed InfluxDB and Grafana without changing the defaults, all you need to do is uncomment the InfluxDB
grafana elements, as shown below:
<metrics-configuration> <reporters> <reporter name="influxdb"> <property name="host" value="localhost"/> <property name="database" value="mydb"/> </reporter> </reporters> <grafana url="http://localhost:3000" api-key="" user="admin" password="admin"> <datasources> <datasource name="xap"> <property name="type" value="influxdb"/> <property name="isDefault" value="true"/> <property name="url" value="http://localhost:8086"/> <property name="database" value="mydb"/> <property name="access" value="proxy"/> </datasource> </datasources> </grafana> </metrics-configuration>
reporter- InfluxDB installation automatically creates a database called
mydb, which matches the default. See InfluxDB Reporter for information about other optional settings.
grafana- Grafana installation defaults to port
admin. In production you'll probably change those in Grafana, so make sure to change them in
metrics.xmlas well. Even better, you can generate an API key in Grafana and place it in the
datasource- This tells Grafana how to connect to your InfluxDB database. Note that InfluxDB uses port
8086by default for an API endpoint, and that we're connecting to the default
We recommend verifying that the default database exists. Some InfluxDB packages do not automatically create the default
mydb database. You can use the InfluxDB Web Admin or shell to check if the database exists, and create it if needed. For more information, see the Getting Started with InfluxDB topic on the InfluxDB website .
After you install InfluxDB and Grafana and configure the
metrics.xml file, start the Web Management Console and navigate to the Monitoring tab - you'll see Grafana's home page (you'll probably get a login page on the first time - just type in the default
admin, and you'll get the home page.
Following are examples of predefined dashboards.
How to Disable Grafana Metrics
By default, Grafana metrics are automatically enabled during product installation.
If you wish to disable Grafana metrics, proceed as follows:
Create a chart with dependencies to other charts (known as an umbrella chart) which are completely external, using the
requirements.yamlfile (a YAML file listing dependencies for the chart).
In the installation of the umbrella chart, include the following parameter:
-- set metrics.enabled=false