Promitor Scraper runtime configuration file (runtime.yaml)

Organization of this page

Syntax

Written in YAML format.

authentication:
  mode: ServicePrincipal
  identityId:  client-ID
server:
  httpPort:  20719
metricSinks:
  prometheusScrapingEndpoint:
    enableMetricTimestamps:true
    baseUriPath: /metrics
metricsConfiguration:
  absolutePath:  installation-directory/jp1pccs/conf/promitor/scraper/metrics-declaration.yaml
resourceDiscovery:
  host: installation-host-name
  enabled: true
  port: 20720

To Page Top

File

runtime.yaml

runtime.yaml.model (model file)

To Page Top

Storage directory

For Windows

When using a physical host: Agent-path\conf\promitor\scraper\
When using a logical host: shared-folder\jp1ima\conf\promitor\scraper\

For Linux

When using a physical host: /opt/jp1ima/conf/promitor/scraper/
When using a logical host: shared-directory/jp1ima/conf/promitor/scraper/

To Page Top

Description

The configuration file that defines Promitor Scraper authentication information, ports used for scraping, and other information.

To Page Top

Character encoding

UTF-8 (without BOM)

To Page Top

Linefeed code

In Windows: CR+LF

In Linux: LF

To Page Top

Timing in which definitions are reflected

Definitions are reflected in Promitor Scraper behavior when restarting Promitor Scraper.

After performing the action above, definitions are reflected in the contents of the integrated operation viewer tree view when the jddcreatetree command and the jddupdatetree command are executed.

To Page Top

Content description

Item^#			Description	Modifiable	Content set by the user in JP1/IM - Agent	Default value in JP1/IM - Agent
authentication:			Authentication for Azure	--	--	--
	[mode:]		Defines authentication mode to use. Options are ServicePrincipal, SystemAssignedManagedIdentity, If Promitor is on Azure, specifying SystemAssignedManagedIdentity or UserAssignedManagedIdentity is recommended. If Promitor is not on Azure, specify ServicePrincipal.	REQ	--	ServicePrincipal
	[identityId:]		Id of the Azure AD entity to authenticate with when integrating with Microsoft Azure. Required when using ServicePrincipal.	REQ	--	None
[server:]			server settubgs	--	--	--
	[httpPort:]		Defines the port to serve HTTP traffic If omitted, this is specified as 80. If you start Promitor on a physical host and a logical host or on more than one logical host, set a different port number for each host.	Y	--	20719
[metricSinks:]			Metric Configuration	--	--	--
	[prometheusScrapingEndpoint:]		Prometheus settings	--	--	--
		[enableMetricTimestamps:]	Defines whether or not a timestamp should be included when the value was scraped on Azure Monitor. Supported values are True to opt-in & False to opt-out.	N	--	true
		baseUriPath:	Controls the path where the scraping endpoint for Prometheus is being exposed.	N	--	`/metrics`
[metricsConfiguration:]			Metric Configuration	--	--	--
	[absolutePath:]		Defines the location of the YAML file that declares what Azure Monitor metrics to scrape. Specify in a character string of 1 to 255 characters. If omitted, this is specified as `/config/metrics-declaration.yaml`.	Y	--	installation-directory`/jp1ima/conf/promitor/scraper/metrics-declaration.yaml`
[resourceDiscovery:]			Promitor Resource Discovery Agent settings	--	--	--
	host:		DNS name of Promitor Resource Discovery agent.	Y	--	The host name is set when installing.
	[enabled:]		Indication whether or not resource discovery is enabled through the Promitor Resource Discovery agent. You can specify true or false.	Y	--	true
	port:		Port of Promitor Resource Discovery agent. If you start Promitor on a physical host and a logical host or on more than one logical host, set a different port number for each host.	Y	--	20720

Legend:: REQ: Required setting, Y: Modifiable, N: Not modifiable, --: Not applicable
#: Brackets ([]) denote optional items.

To Page Top