Management API Reference for registry=prometheus

Attributes (2)

• context - The context root from which to serve Prometheus metrics (e.g., "/metrics" or "/prometheus"). Note: Prometheus is not supported on host controllers.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The context root from which to serve Prometheus metrics (e.g., \"/metrics\" or \"/prometheus\"). Note: Prometheus is not supported on host controllers.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• security-enabled - Whether the context should be secured

  Type	BOOLEAN
  Default Value	true
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the context should be secured", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• 🅲  add - The operation to add the Prometheus registry

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  context	STRING	true	true		The context root from which to serve Prometheus metrics (e.g., "/metrics" or "/prometheus"). Note: Prometheus is not supported on host controllers.
  security-enabled	BOOLEAN	false	true	true	Whether the context should be secured

  Raw DMR model

  { "operation-name" : "add", "description" : "The operation to add the Prometheus registry", "request-properties" : { "context" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The context root from which to serve Prometheus metrics (e.g., \"/metrics\" or \"/prometheus\"). Note: Prometheus is not supported on host controllers.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "security-enabled" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Whether the context should be secured", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default" } }, "reply-properties" : {}, "stability" : "community", "read-only" : false, "runtime-only" : false }

• remove - The operation to remove the Prometheus registry

  Raw DMR model

  { "operation-name" : "remove", "description" : "The operation to remove the Prometheus registry", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.micrometer.registry.prometheus

          
  <feature spec="subsystem.micrometer.registry.prometheus">
    <param name="context" value="{value}"/>
    <param name="security-enabled" value="{value}"/>
  <feature/>
          
        

  📋