cs3api
Configuration for the CS3API of the Mentix service
Mentix (Mesh Entity Exchanger) is a service to read and write mesh topology data to and from one or more sources (e.g., a GOCDB instance) and export it to various targets like an HTTP endpoint or Prometheus.
The relative root path of all exposed HTTP endpoints of Mentix.
[http.services.mentix]
prefix = "/mentix"
How frequently Mentix should pull and update the mesh data. Supports common time duration strings, like “1h30m”, “1d” etc.
[http.services.mentix]
update_interval = "15m"
The service types that are considered as critical/essential.
[http.services.mentix.services]
critical_types = ["REVAD]
Mentix is decoupled from the actual sources of the mesh data by using so-called connectors. A connector is used to gather the data from a certain source, which are then converted into Mentix’ own internal format.
Supported connectors:
Mentix can import mesh data from various sources and write it to one or more targets through the corresponding connectors.
Supported importers:
Mentix exposes its gathered data by using one or more exporters. Such exporters can, for example, write the data to a file in a specific format, or offer the data via an HTTP endpoint.
Supported exporters:
webapi
exporter. Data can be retrieved at the configured relative endpoint (see here). The web API currently doesn’t support any parameters but will most likely be extended in the future.cs3api
exporter exposes its data via an HTTP endpoint. Data can be retrieved at the configured relative endpoint (see here). The data is compliant with the CS3API ProviderInfo
structure.siteloc
exposes location information of all sites to be consumed by Grafana at the configured relative endpoint (see here).promsd
Prometheus supports discovering new services it should monitor via external configuration files (hence, this is called file-based service discovery). Mentix can create such files using the promsd
exporter. To use this exporter, you have to specify the target output files in the configuration (see here). You also have to set up the discovery service in Prometheus by adding a scrape configuration like the following example to the Prometheus configuration (for more information, visit the official Prometheus documentation):
- job_name: 'sciencemesh'
file_sd_configs:
- files:
- '/usr/share/prom/sciencemesh_services.json'
metrics The Metrics exporter exposes various site-specific metrics through Prometheus.
Configuration for the CS3API of the Mentix service
Configuration for the GOCDB connector of the Mentix service
Configuration for the Metrics exporter of the Mentix service
Configuration for the Prometheus SD exporter of the Mentix service
Configuration for the Site Locations exporter of the Mentix service
Configuration for the WebAPI of the Mentix service