Package de.iip_ecosphere.platform.monitoring.prometheus

Class IipEcospherePrometheusExporter

java.lang.Object

de.iip_ecosphere.platform.monitoring.MonitoringReceiver

de.iip_ecosphere.platform.monitoring.prometheus.IipEcospherePrometheusExporter

public class IipEcospherePrometheusExporter
extends de.iip_ecosphere.platform.monitoring.MonitoringReceiver

Observes IIP-Ecosphere standard transport channels and feeds the information into Prometheus. [public for testing]

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	IipEcospherePrometheusExporter.MyPrometheusMeterRegistry	Exhibits creating a custom meter.
protected class	IipEcospherePrometheusExporter.PrometheusExporter	Implements a specialized exporter for prometheus.
private static class	IipEcospherePrometheusExporter.PrometheusMetricsServlet	The default metrics servlet.
static class	IipEcospherePrometheusExporter.RegistryServlet	A simple metrics servlet for a given local, bridged metrics registry.

Nested classes/interfaces inherited from class de.iip_ecosphere.platform.monitoring.MonitoringReceiver

de.iip_ecosphere.platform.monitoring.MonitoringReceiver.Exporter

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.catalina.Context	context
static final String	DEFAULT_METRICS_ENDPOINT
static final String	DEFAULT_METRICS_SERVLET_NAME
private static final io.micrometer.core.instrument.config.MeterFilter[]	METER_FILTERS
private Supplier<ConfigModifier>	modifier
private int	port
private org.apache.catalina.startup.Tomcat	server
private File	webapps

Constructor Summary

Constructors

Constructor	Description
IipEcospherePrometheusExporter()	Creates a prometheus exporter.

Method Summary

Modifier and Type	Method	Description
protected String	addServlet(String id, javax.servlet.Servlet servlet)	Adds a servlet to the tomcat instance.
protected de.iip_ecosphere.platform.monitoring.MonitoringReceiver.Exporter	createExporter(String id)
private String	getPath(String id)	Returns the servlet mapping path.
protected void	notifyExporterAdded(de.iip_ecosphere.platform.monitoring.MonitoringReceiver.Exporter exporter)
protected void	notifyExporterRemoved(de.iip_ecosphere.platform.monitoring.MonitoringReceiver.Exporter exporter)
protected void	removeServlet(String id)	Removes the given servlet from the server container.
void	setModifierSupplier(Supplier<ConfigModifier> modifier)	Defines the modifier supplier.
void	start()
void	stop()
private void	writeScrapeConfig()	Changes the prometheus configuration for modified scrape setup.

Methods inherited from class de.iip_ecosphere.platform.monitoring.MonitoringReceiver

exporters, notifyMeterAdded, notifyMeterReception, notifyStatusReceived, obtainExporter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_METRICS_SERVLET_NAME

public static final String DEFAULT_METRICS_SERVLET_NAME

See Also:

• Constant Field Values

DEFAULT_METRICS_ENDPOINT

public static final String DEFAULT_METRICS_ENDPOINT

See Also:

• Constant Field Values

METER_FILTERS

private static final io.micrometer.core.instrument.config.MeterFilter[] METER_FILTERS

server

private org.apache.catalina.startup.Tomcat server

context

private org.apache.catalina.Context context

modifier

private Supplier<ConfigModifier> modifier

port

private int port

webapps

private File webapps

Constructor Details

IipEcospherePrometheusExporter

public IipEcospherePrometheusExporter()

Creates a prometheus exporter.

See Also:

• setModifierSupplier(Supplier)

Method Details

setModifierSupplier

public void setModifierSupplier(Supplier<ConfigModifier> modifier)

Defines the modifier supplier.

Parameters:

modifier - the modifier supplier

start

public void start()

Overrides:

start in class de.iip_ecosphere.platform.monitoring.MonitoringReceiver

stop

public void stop()

Overrides:

stop in class de.iip_ecosphere.platform.monitoring.MonitoringReceiver

addServlet

protected String addServlet(String id,
 javax.servlet.Servlet servlet)

Adds a servlet to the tomcat instance. Tomcat must at least be initialized:

Parameters:

id - the id of the servlet, also used for the path

servlet - the servlet instance

Returns:

the path to the servlet

getPath

private String getPath(String id)

Returns the servlet mapping path.

Parameters:

id - the servlet id

Returns:

the mapping path

removeServlet

protected void removeServlet(String id)

Removes the given servlet from the server container.

Parameters:

id - the servlet id

createExporter

protected de.iip_ecosphere.platform.monitoring.MonitoringReceiver.Exporter createExporter(String id)

Specified by:

createExporter in class de.iip_ecosphere.platform.monitoring.MonitoringReceiver

notifyExporterAdded

protected void notifyExporterAdded(de.iip_ecosphere.platform.monitoring.MonitoringReceiver.Exporter exporter)

Overrides:

notifyExporterAdded in class de.iip_ecosphere.platform.monitoring.MonitoringReceiver

notifyExporterRemoved

protected void notifyExporterRemoved(de.iip_ecosphere.platform.monitoring.MonitoringReceiver.Exporter exporter)

Overrides:

notifyExporterRemoved in class de.iip_ecosphere.platform.monitoring.MonitoringReceiver

writeScrapeConfig

private void writeScrapeConfig()

Changes the prometheus configuration for modified scrape setup.