Promitor Scraper configuration file (metrics-declaration.yaml)

Organization of this page

Syntax

Written in YAML format.

verion: v1
azureMetadata:
  tenantId: tenant-ID
  subscriptionId: subscription-ID
  resourceGroupName: resource-group-name
metricDefaults:
  aggregation:
    interval: 00:05:00
  scraping:
  schedule: "0 * * ? * *"
metrics:
  - name: azure_virtual_machine_disk_read_bytes_total
    description: "Bytes read from disk during monitoring period."
    scraping:
      schedule: "0 * * ? * *"
    azureMetricConfiguration:
      metricName: Disk Read Bytes
      aggregation:
        type: Total
    resourceDiscoveryGroups:
    - name: virtual-machine-group

To Page Top

File

metrics-declaration.yaml

metrics-declaration.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 the metrics to be acquired by the Promitor Scraper.

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
version				Version of declaration that is used. Allowed values are v1.	N	--	v1
azureMetadata:				Azure information	--	--	--
	tenantId:			The id of the Azure tenant that will be queried.	REQ	Tenant ID	None
	subscriptionId:			The id of the default subscription to query.	REQ	Subscription ID	None
	resourceGroupName:			The name of the default resource group to query.	REQ	Resource group name	None
	[cloud:]			The name of the Azure cloud to use. Options are Global (default), China, UsGov & Germany.	Y	--	None
metricDefaults:				Metric default settings	--	--	--
	aggregation:			Aggregation settings	Y	--	--
		[interval]:		The default interval which defines over what period measurements of a metric should be aggregated. a cron that fits your needs. Set this parameter to a value greater than or equal to 5 minutes (00:05:00).	Y	--	00:05:00
	[limit]:			The default maximum amount of resources to scrape when using dimensions or filters. If omitted, this is specified as 10000.	Y	--	None
	labels:			The default labels that will be applied to all metrics.	--	--	--
		<key>: <value>		Specify the key and value in a character string of 1 to 255 characters. The key value must be specified with characters that match the regular expression [a-z _:][a-z0-9_:]*. Multibyte characters can not be specified for the value.	Y	--	None
	scraping:			scraping settings	--	--	--
		schedule:		A cron expression that controls the frequency of which all the configured metrics will be scraped from Azure Monitor. You can use crontab-generator.org to generate a cron that fits your needs. Setting example: If the schedule is set to every minute `0 * * ? * *`	Y	--	"0 * * ? * *" The Promitor setting example, and the default collection interval for Prometheus and Azure Monitor provided by JP1/IM - Agent are one minute.
metrics:				metrics settings	--	--	--
-	name:			Name of the metric that will be reported. Specify in a character string of 1 to 255 characters. The value must be specified with characters that match the regular expression [a-zA-Z_:][a-zA-Z0-9_:]*.	Y	--	Varies depending on the metric.
	description:			Description for the metric that will be reported. Specify using 1 to 255 characters, excluding control characters.	Y	--	Varies depending on the metric.
	resourceType:			Defines what type of resource needs to be queried. The following shows values that can be specified: VirtualMachine FunctionApp ContainerInstance KubernetesService FileStorage BlobStorage ServiceBusNamespace CosmosDb SqlDatabase SqlManagedInstane SqlElasticPool LogicApp	Y	--	Varies depending on the metric.
	[labels:]			Defines a set of custom labels to include for a given metric.	--	--	--
		<key>: <value>		Specify the key and value in a character string of 1 to 255 characters. The key value must be specified with characters that match the regular expression [a-z _:][a-z0-9_:]*. Multibyte characters can not be specified for the value.	Y	--	None
	[scraping:]			scraping settings	--	--	--
		schedule:		A scraping schedule for the individual metric; overrides the the one specified in metricDefaults Setting example: If the schedule is set to every minute `0 * * ? * *`	Y	--	None
	azureMetricConfiguration:			Azure metric configuration	--	--	--
		metricName:		The name of the metric in Azure Monitor to query For details on specifiable values, see Metrics you can collect in 3.15.1(1)(h) Promitor (Azure Monitor performance data collection capability) in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.	Y	--	Varies depending on the metric.
		[limit:]		The maximum amount of resources to scrape when using dimensions or filters. If omitted, this is specified as the metricDefault.limit value.	Y	--	None
		[dimension:]		The dimension that should be used to scrape a multi-dimensional metric in Azure Monitor.	--	--	--
			name:	The name of the dimension that should be used to scrape a multi-dimensional metric in Azure Monitor.	Y	--	Varies depending on the metric.
		aggregation:		Aggregation settings	--	--	--
			type:	The aggregation that needs to be used when querying Azure Monitor	Y	--	Varies depending on the metric.
			[interval:]	Overrides the default aggregation interval defined in metricDefaults.aggregation.interval with a new interval	Y	--	None
	[resources:]			An array of one or more resources to get metrics for. The fields required vary depending on the resourceType being created, and are documented for each resource.	--	--	--
	-	<property>		The method of specification varies depending on the resourceType, such as the name of the resource. The following shows values to be specified: If the resource type is VirtualMachine virtualMachineName If the resource type is FunctionApp functionAppName, slotName (optional) If the resource type is ContainerInstance containerGroup If the resource type is KubernetesService clusterName If the resource type is FileStorage accountName If the resource type is BlobStorage accountName If the resource type is ServiceBusNamespace namespace, queueName (optional), topicName (optional) If the resource type is CosmosDb dbName If the resource type is SqlDatabase serverName, databaseName If the resource type is SqlServer serverName If the resource type is SqlManagedInstance instanceName If the resource type is SqlElasticPool serverName, poolName If the resource type is LogicApp workflowName	Y	--	Varies depending on the metric.
		[resourceGroupName:]		Changes the resource group that contains resource. (Overrides azureMetadata.resourceGroupName)	Y	--	None
		[subscriptionId:]		Changes the subscription id to which the resource belongs. (Overrides azureMetadata.subscriptionId)	Y	--	None
	[resourceDiscoveryGroups:]			An array of one or more resource discovery groups that will be used to automatically discover all resources through Promitor Resource Discovery. For every found resource, it will get the metrics and report them.	--	--	--
	-	name:		Discovery group name.	Y	--	Varies depending on the metric.

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

To Page Top