Yet another cloudwatch exporter configuration file (jpc_ya_cloudwatch_exporter.yml)

Organization of this page

Format
File
Storage directory
Description
Character code
Line feed code
When the definitions are applied
Information that is specified

Format

Write in YAML format.

discovery:
  exportedTagsOnMetrics:
    AWS/EC2:
      - jp1_pc_nodelabel
    AWS/Lambda:
      - jp1_pc_nodelabel
    AWS/S3:
      - jp1_pc_nodelabel
    AWS/DynamoDB:
      - jp1_pc_nodelabel
    AWS/States:
      - jp1_pc_nodelabel
    AWS/SQS:
      - jp1_pc_nodelabel
    AWS/ESC:
      - jp1_pc_nodelabel
    AWS/EBS:
      - jp1_pc_nodelabel
    AWS/EFS:
      - jp1_pc_nodelabel
    AWS/FSx:
      - jp1_pc_nodelabel
    AWS/SNS:
      - jp1_pc_nodelabel
    AWS/RDS:
      - jp1_pc_nodelabel
  jobs:
  - type: AWS/EC2
    regions:
      - ap-northeast-1
    period: 0
    length: 600
    delay: 120
    metrics:
      - name: CPUUtilization
        statistics:
        - Average
      - name: DiskReadBytes
        statistics:
        - Sum
      - name: DiskWriteBytes
        statistics:
        - Sum

To Page Top

File

jpc_ya_cloudwatch_exporter.yml

jpc_ya_cloudwatch_exporter.yml.model (model file)

To Page Top

Storage directory

■Integrated agent host

In Windows:

For a physical host

Agent-path\conf\
For a logical host

shared-folder\jp1ima\conf\

In Linux:

For a physical host

/opt/jp1ima/conf/
For a logical host

shared-directory/jp1ima/conf/

■Integrated manager host (model File only)

/opt/jp1pccspkg/jp1_pc_agent_cloud/jp1_pc_agent_cloud_linux_JP1/IM - Agent-version-number-(VVRRSS-format)/ya_cloudwatch_exporter/conf/

■Monitoring agent host

For a physical host

Install the monitoring agent directory/jp1pccs/conf/
For a logical host

shared-directory/jp1pccs/conf/

To Page Top

Description

A configuration file that specifies the behavior of Yet another cloudwatch exporter.

To Page Top

Character code

UTF-8 (without BOM)

To Page Top

Line feed code

In Windows: CR+LF

In Linux: LF

To Page Top

When the definitions are applied

When you restart Yet another cloudwatch exporter, it will be reflected in the behavior of Yet another cloudwatch exporter.

Also, when you execute the jddcreatetree command and the jddupdatetree command after performing the above operation, it is reflected in the displayed contents of the tree in the integrated operation viewer.

To Page Top

Information that is specified

Top-level parameters

The discovery listed in the following table is listed.

Item	Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
discovery	Configure Auto-discovery. For more information, see <Auto-discovery configuration> below.	Y	See <Auto-discovery configuration>.	None

Item

Description

Changeability

What You Setup in Your JP1/IM - Agent

JP1/IM - Agent Defaults Value

discovery

Configure Auto-discovery.

For more information, see <Auto-discovery configuration> below.

See <Auto-discovery configuration>.

None

Legend:: Y: Changeable

<Auto-discovery configuration>

Item	Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
<Auto-discovery configuration>	--	--	--	--
	exportedTagsOnMetrics	Specifies a list of tags per service to export to all metrics. Be sure to specify the jp1_pc_nodelabel tag. <Example List> exportedTagsOnMetrics: AWS/EC2: - jp1_pc_nodelabel - type Precautions Only tagged AWS resources are discovered.	Y	List of tags per service to export to all metrics	exportedTagsOnMetrics: AWS/EC2: - jp1_pc_nodelabel AWS/Lambda: - jp1_pc_nodelabel AWS/S3: - jp1_pc_nodelabel AWS/DynamoDB: - jp1_pc_nodelabel AWS/States: - jp1_pc_nodelabel AWS/SQS: - jp1_pc_nodelabel AWS/EBS: - jp1_pc_nodelabel AWS/ECS: - jp1_pc_nodelabel AWS/EFS: - jp1_pc_nodelabel AWS/FSx: - jp1_pc_nodelabel AWS/RDS: - jp1_pc_nodelabel AWS/SNS: - jp1_pc_nodelabel ECS/ContainerInsights: - jp1_pc_nodelabel
	jobs	Configure the list of Auto-discovery jobs. See <Auto-discovery job> below.	R	See <Auto-discovery job>.	--

Item

Description

Changeability

What You Setup in Your JP1/IM - Agent

JP1/IM - Agent Defaults Value

<Auto-discovery configuration>

exportedTagsOnMetrics

Specifies a list of tags per service to export to all metrics.

Be sure to specify the jp1_pc_nodelabel tag.

exportedTagsOnMetrics:

AWS/EC2:

- jp1_pc_nodelabel

- type

Precautions: Only tagged AWS resources are discovered.

List of tags per service to export to all metrics

exportedTagsOnMetrics:

AWS/EC2:

- jp1_pc_nodelabel

AWS/Lambda:

- jp1_pc_nodelabel

AWS/S3:

- jp1_pc_nodelabel

AWS/DynamoDB:

- jp1_pc_nodelabel

AWS/States:

- jp1_pc_nodelabel

AWS/SQS:

- jp1_pc_nodelabel

AWS/EBS:

- jp1_pc_nodelabel

AWS/ECS:

- jp1_pc_nodelabel

AWS/EFS:

- jp1_pc_nodelabel

AWS/FSx:

- jp1_pc_nodelabel

AWS/RDS:

- jp1_pc_nodelabel

AWS/SNS:

- jp1_pc_nodelabel

ECS/ContainerInsights:

- jp1_pc_nodelabel

jobs

Configure the list of Auto-discovery jobs.

See <Auto-discovery job> below.

See <Auto-discovery job>.

Legend:: R: Required, Y: Changeable, --: Not applicable

<Auto-discovery job>

Item		Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
<Auto-discovery job>		--	--	--	--
	regions	Specify a list of AWS Regions.	R	List of AWS Regions	ap-northeast-1
	type	Specify the namespace name, such as "AWS/EC2", "AWS/S3", and so on. For details about the namespaces (services) that can be specified, see the following section of the JP1/Integrated Management 3 - Manager Overview and System Design Guide. JP1/IM - Agent's Yet another cloudwatch exporter supports AWS namespaces for monitoring in 3.15.6(1)(k) Creating an IM Management Node for Yet another cloudwatch exporter	R	Namespace name	AWS/EC2 AWS/Lambda AWS/S3 AWS/DynamoDB AWS/States AWS/SQS AWS/EBS AWS/ECS AWS/EFS AWS/FSx AWS/RDS AWS/SNS ECS/ContainerInsights
	length	Specifies the duration in seconds for retrieving data from CloudWatch. The acquisition start time is "current time - (length + delay)".	Y	Time to request data (in seconds)	Non-AWS/S3 settings length: 600 AWS/S3 settings length: 172800
	delay	Specifies the number of seconds in advance to request data for the current time. The acquisition end time is "current time - delay".	Y	--	delay: 120
	roles	Specify the IAM role to assume. You can write up to two roles. <Configuration Example> roles: - roleArn: "arn:aws:iam::1111111111111:role/cross_access_role" - roleArn: "arn:aws:iam::2222222222222:role/cross_access_role"	Y	List of IAM Roles to Assume	Not specified
	searchTags	Specifies a list of key-value pairs to use (all must match) to use if only data with a particular tag is to be collected. The value can be a regular expression. Do not delete the entries that are set by default. <Configuration Example> searchTags: - key: env value: production	Y	List of key-value pairs	searchTags: - key: jp1_pc_nodelabel value: .*
	period	Specifies the granularity of the data retrieved from CloudWatch in seconds.	Y	Statistics period in seconds	0
	customTags	Specifies the custom tag to add as a list of key-value pairs. <Configuration Example> customTags: - key: CustomTag value: CustomValue	Y	Custom Tags	Not specified
	metrics	Configure a list of metric definitions. For more information, see <metric definitions> below.	R	List of metric definitions	Set the metric defined in the initial value of the metric definition file. For the initial values of the metric definition file, see the section explaining Model file settings (initial state) in Yet another cloudwatch exporter metric definition file (metrics_ya_cloudwatch_exporter.conf).

Legend:: R: Required, Y: Changeable, --: Not applicable

Item		Description	Changeability	What You Setup in Your JP1/IM - Agent	JP1/IM - Agent Defaults Value
<metric definitions>		--	--	--	--
	name	Specify the CloudWatch metric name.	R	CloudWatch metric name	None
	statistics	Specifies the statistic type in list format. Specify Minimum, Maximum, and so on. <Configuration Example> statistics: - Average	R	Statistic type	None
	period	Specifies the granularity of the data retrieved from CloudWatch in seconds. This definition overrides the job-level setting.	Y	Statistics period in seconds	If the <Auto-discovery job> period is 0 300 If the <Auto-discovery job> period is other than 0 Settings value of period in <Auto-discovery job>
	nilToZero	Specify True to treat 0 when information cannot be retrieved from CloudWatch. The default is False.	Y	Specify True to enable.	Not specified

Legend:: R: Required, Y: Changeable, --: Not applicable

To Page Top