Metering V2 Properties in Cloudera Runtime 7.3.2

Role groups:

Gateway

Advanced

Deploy Directory

Description: The directory where the client configs will be deployed
Related Name
Default Value: /etc/meteringv2
API Name: client_config_root_dir
Required: true

Metering V2 Client Advanced Configuration Snippet (Safety Valve) for meteringv2-conf/meteringv2-client.properties

Description: For advanced use only, a string to be inserted into the client configuration for meteringv2-conf/meteringv2-client.properties.
Related Name
Default Value
API Name: meteringv2-conf/meteringv2-client.properties_client_config_safety_valve
Required: false

Monitoring

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Other

Alternatives Priority

Description: The priority level that the client configuration will have in the Alternatives system on the hosts. Higher priority levels will cause Alternatives to prefer this configuration over any others.
Related Name
Default Value: 50
API Name: client_config_priority
Required: true

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Deploy Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Deploy Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Parameter Validation: Metering V2 Client Advanced Configuration Snippet (Safety Valve) for meteringv2-conf/meteringv2-client.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Client Advanced Configuration Snippet (Safety Valve) for meteringv2-conf/meteringv2-client.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2-conf/meteringv2-client.properties_client_config_safety_valve
Required: true

Metering V2 Server

Advanced

Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/dbus-credentials.properties

Description: For advanced use only. A string to be inserted into conf/dbus-credentials.properties for this role only.
Related Name
Default Value
API Name: conf/dbus-credentials.properties_role_safety_valve
Required: false

Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/meteringv2.properties

Description: For advanced use only. A string to be inserted into conf/meteringv2.properties for this role only.
Related Name
Default Value
API Name: conf/meteringv2.properties_role_safety_valve
Required: false

Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/ssl.properties

Description: For advanced use only. A string to be inserted into conf/ssl.properties for this role only.
Related Name
Default Value
API Name: conf/ssl.properties_role_safety_valve
Required: false

Metering V2 Server Environment Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of this role except client configuration.
Related Name
Default Value
API Name: METERINGV2_SERVER_role_env_safety_valve
Required: false

Enable auto refresh for metric configurations

Description: When true, Enable Metric Collection and Metric Filter parameters will be set automatically if they're changed. Otherwise, a refresh by hand is required.
Related Name
Default Value: false
API Name: metric_config_auto_refresh
Required: false

Automatically Restart Process

Description: When set, this role's process is automatically (and transparently) restarted in the event of an unexpected failure. This configuration applies in the time after the Start Wait Timeout period.
Related Name
Default Value: false
API Name: process_auto_restart
Required: true

Enable Metric Collection

Description: Cloudera Manager agent monitors each service and each of its role by publishing metrics to the Cloudera Manager Service Monitor. Setting it to false will stop Cloudera Manager agent from publishing any metric for corresponding service/roles. This is usually helpful for services that generate large amount of metrics which Service Monitor is not able to process.
Related Name
Default Value: true
API Name: process_should_monitor
Required: true

Process Start Retry Attempts

Description: Number of times to try starting a role's process when the process exits before the Start Wait Timeout period. After a process is running beyond the Start Wait Timeout, the retry count is reset. Setting this configuration to zero will prevent restart of the process during the Start Wait Timeout period.
Related Name
Default Value: 3
API Name: process_start_retries
Required: false

Process Start Wait Timeout

Description: The time in seconds to wait for a role's process to start successfully on a host. Processes which exit/crash before this time will be restarted until reaching the limit specified by the Start Retry Attempts count parameter. Setting this configuration to zero will turn off this feature.
Related Name
Default Value: 20
API Name: process_start_secs
Required: false

Logs

Metering V2 Server Log Directory

Description: The log directory for log files of the role Metering V2 Server.
Related Name: log_dir
Default Value: /var/log/meteringv2
API Name: log_dir
Required: false

Monitoring

Enable Health Alerts for this Role

Description: When set, Cloudera Manager will send alerts when the health of this role reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Log Directory Free Space Monitoring Absolute Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory.
Related Name
Default Value: Warning: 10 GiB, Critical: 5 GiB
API Name: log_directory_free_space_absolute_thresholds
Required: false

Log Directory Free Space Monitoring Percentage Thresholds

Description: The health test thresholds for monitoring of free space on the filesystem that contains this role's log directory. Specified as a percentage of the capacity on that filesystem. This setting is not used if a Log Directory Free Space Monitoring Absolute Thresholds setting is configured.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: log_directory_free_space_percentage_thresholds
Required: false

File Descriptor Monitoring Thresholds

Description: The health test thresholds of the number of file descriptors used. Specified as a percentage of file descriptor limit.
Related Name
Default Value: Warning: 50.0 %, Critical: 70.0 %
API Name: meteringv2_server_fd_thresholds
Required: false

Metering V2 Server Host Health Test

Description: When computing the overall Metering V2 Server health, consider the host's health.
Related Name
Default Value: true
API Name: meteringv2_server_host_health_enabled
Required: false

Metering V2 Server Process Health Test

Description: Enables the health test that the Metering V2 Server's process state is consistent with the role configuration
Related Name
Default Value: true
API Name: meteringv2_server_scm_health_enabled
Required: false

Metric Filter

Description

Defines a Metric Filter for this role. Cloudera Manager Agents will not send filtered metrics to the Service Monitor. Define the following fields:

Health Test Metric Set - Select this parameter to collect only metrics required for health tests.
Default Dashboard Metric Set - Select this parameter to collect only metrics required for the default dashboards. For user-defined charts, you must add the metrics you require for the chart using the Custom Metrics parameter.
Include/Exclude Custom Metrics - Select Include to specify metrics that should be collected. Select Exclude to specify metrics that should not be collected. Enter the metric names to be included or excluded using the Metric Name parameter.
Metric Name - The name of a metric that will be included or excluded during metric collection.

If you do not select Health Test Metric Set or Default Dashboard Metric Set, or specify metrics by name, metric filtering will be turned off (this is the default behavior).For example, the following configuration enables the collection of metrics required for Health Tests and the jvm_heap_used_mb metric:

Include only Health Test Metric Set: Selected.
Include/Exclude Custom Metrics: Set to Include.
Metric Name: jvm_heap_used_mb

You can also view the JSON representation for this parameter by clicking View as JSON. In this example, the JSON looks like this:

{
  "includeHealthTestMetricSet": true, 
  "filterType": "whitelist",
  "metrics": ["jvm_heap_used_mb"]
}

Related Name

Default Value

API Name

monitoring_metric_filter

Required

false

OpenTelemetry Collector Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: exporters: prometheusremotewrite/$ROLE_NAME: endpoint: $ROLE_PARAM(otelcol_remote_write_url) timeout: 30s retry_on_failure: enabled: true initial_interval: 10s max_interval: 40s max_elapsed_time: 300s auth: authenticator: cdpauth/thanos-$ROLE_NAME
API Name: otelcol_exporters
Required: false

OpenTelemetry Collector Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value: extensions: cdpauth/thanos-$ROLE_NAME: cdp_access_key_id: '$CDP_ACCESS_KEY_ID' send_token: true token_valid_for_sec: 3600 cdp_private_key: $CDP_PRIVATE_KEY cdp_authentication_method: 'rsav1'
API Name: otelcol_extensions
Required: false

OpenTelemetry Collector Helper Port

Description: This port can be used for JMX Exporter to implement a Prometheus exporter or for other OpenTelemetry Collector related purposes
Related Name
Default Value
API Name: otelcol_helper_port
Required: false

OpenTelemetry Collector Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_processors
Required: false

OpenTelemetry Collector Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_receivers
Required: false

OpenTelemetry Collector Remote Write Password

Description: Remote write password for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_password) expression. Specify $INFRA(cdp_request_signer_password) when forwarding to Cloudera Observability central monitoring. (This is the default.)
Related Name
Default Value: ******
API Name: otelcol_remote_write_password
Required: false

OpenTelemetry Collector Remote Write URL

Description: Remote write URL for the OpenTelemetry Collector. This param is for convenience and intended to be used at the exporters section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_url) expression. Specify $INFRA(cdp_request_signer_url) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_url)
API Name: otelcol_remote_write_url
Required: false

OpenTelemetry Collector Remote Write Username

Description: Remote write username for the OpenTelemetry Collector. This param is for convenience and intended to be used at the extensions section of Otelcol settings using the $ROLE_PARAM(otelcol_remote_write_user) expression. Specify $INFRA(cdp_request_signer_username) when forwarding to Cloudera Observability central monitoring.
Related Name
Default Value: $INFRA(cdp_request_signer_username)
API Name: otelcol_remote_write_user
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Define the exporters settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_exporters
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Define the extensions settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_extensions
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Define the processors settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_processors
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Define the receivers settings as a yaml snippet according to the OpenTelemetry Collector standards. A number of variables can help to use the same config everywhere. The follow strings or expressions will be substituted: $HOST_NAME, $CLUSTER_NAME, $CLUSTER_ID, $SERVICE_TYPE, $SERVICE_NAME, $ROLE_NAME, $ROLE_TYPE, $ROLE_PARAM(my_parameter_name) - e.g.: a port parameter for the role's metrics, $DECODE_B64(...) and $DECODE_URL(...) to decode encoded parameters, $ENV_PARAM(name) to fetch params from the process' environment, $SYS_PARAM(name) to fetch java system properties.
Related Name
Default Value
API Name: otelcol_rtm_logs_receivers
Required: false

Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_rtm_logs_service
Required: false

OpenTelemetry Collector Service Section

Description: Define the service settings as a yaml snippet according to the OpenTelemetry Collector standards. Variable substitution available, see the receivers' help.
Related Name
Default Value
API Name: otelcol_service
Required: false

Enable OpenTelemetry Collector (beta)

Description: OpenTelemetry Collector support is a new beta feature (will change without notice) which can run OpenTelemetry Collector as an agent together with the CM Agent to forward metrics to a Prometheus like storage.
Related Name
Default Value: false
API Name: otelcol_should_collect
Required: true

Enable Real-Time Monitoring for Jobs / Queries with OpenTelemetry

Description: This enables OpenTelemetry Collector as an agent together with the CM Agent to forward real-time monitoring data about jobs / queries to Observability backend. The configuration of the subsections shouldn't be modified manually.
Related Name
Default Value: false
API Name: otelcol_should_collect_rtm_logs
Required: true

Swap Memory Usage Rate Thresholds

Description: The health test thresholds on the swap memory usage rate of the process. Specified as the change of the used swap memory during the predefined period.
Related Name
Default Value: Warning: Never, Critical: Never
API Name: process_swap_memory_rate_thresholds
Required: false

Swap Memory Usage Rate Window

Description: The period to review when computing unexpected swap memory usage change of the process.
Related Name: common.process.swap_memory_rate_window
Default Value: 5 minute(s)
API Name: process_swap_memory_rate_window
Required: false

Process Swap Memory Thresholds

Description: The health test thresholds on the swap memory usage of the process. This takes precedence over the host level threshold.
Related Name
Default Value: Warning: 200 B, Critical: Never
API Name: process_swap_memory_thresholds
Required: false

Role Triggers

Description

The configured triggers for this role. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:

triggerName (mandatory) - The name of the trigger. This value must be unique for the specific role.
triggerExpression (mandatory) - A tsquery expression representing the trigger.
streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.

For example, the following JSON formatted trigger configured for a DataNode fires if the DataNode has more than 1500 file descriptors opened:

[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleName=$ROLENAME and last(fd_open) > 1500) DO health:bad",
  "streamThreshold": 0, "enabled": "true"}]

See the trigger rules documentation for more details on how to write triggers using tsquery.The JSON format is evolving and may change and, as a result, backward compatibility is not guaranteed between releases.

Related Name

Default Value

[]

API Name

role_triggers

Required

true

Unexpected Exits Thresholds

Description: The health test thresholds for unexpected exits encountered within a recent period specified by the unexpected_exits_window configuration for the role.
Related Name
Default Value: Warning: Never, Critical: Any
API Name: unexpected_exits_thresholds
Required: false

Unexpected Exits Monitoring Period

Description: The period to review when computing unexpected exits.
Related Name
Default Value: 5 minute(s)
API Name: unexpected_exits_window
Required: false

Other

Graceful Shutdown Timeout

Description: The timeout in milliseconds to wait for graceful shutdown to complete.
Related Name
Default Value: 0 second(s)
API Name: graceful_stop_timeout
Required: false

DBUS Access Key ID

Description: The Access Key ID
Related Name: databus_access_key_id
Default Value
API Name: meteringv2.dbus.access.key.id
Required: true

DBUS Access Secret Key

Description: The Access Secret Key to use for DBUS calls
Related Name: databus_access_secret_key
Default Value
API Name: meteringv2.dbus.access.secret.key
Required: true

DBUS Access Secret Key Algorithm

Description: The Access Secret Key Algorithm
Related Name: databus_access_secret_key_algo
Default Value
API Name: meteringv2.dbus.access.secret.key.algo
Required: true

DBUS App Name

Description: The DBUS App Name
Related Name: meteringv2.dbus.appname
Default Value
API Name: meteringv2.dbus.appname
Required: true

DBUS Host

Description: The DBUS Host
Related Name: meteringv2.dbus.host
Default Value
API Name: meteringv2.dbus.host
Required: true

DBUS HTTPS Proxy

Description: The DBUS HTTPS Proxy
Related Name: meteringv2.dbus.https.proxy
Default Value
API Name: meteringv2.dbus.https.proxy
Required: false

DBUS Partition Key

Description: The DBUS Partition Key
Related Name: meteringv2.dbus.partition.key
Default Value
API Name: meteringv2.dbus.partition.key
Required: false

DBUS Proxy Password

Description: The DBUS Proxy Password
Related Name: meteringv2.dbus.proxy.password
Default Value
API Name: meteringv2.dbus.proxy.password
Required: false

DBUS Proxy URL

Description: The DBUS Proxy URL
Related Name: meteringv2.dbus.proxy.url
Default Value
API Name: meteringv2.dbus.proxy.url
Required: false

DBUS Proxy User

Description: The DBUS Proxy User
Related Name: meteringv2.dbus.proxy.user
Default Value
API Name: meteringv2.dbus.proxy.user
Required: false

DBUS Scheme

Description: The DBUS Scheme
Related Name: meteringv2.dbus.scheme
Default Value: https
API Name: meteringv2.dbus.scheme
Required: false

DBUS Stream

Description: The DBUS Stream
Related Name: meteringv2.dbus.stream
Default Value
API Name: meteringv2.dbus.stream
Required: true

Region

Description: The Cluster Region
Related Name: meteringv2.region
Default Value
API Name: meteringv2.region
Required: false

Performance

Maximum Process File Descriptors

Description: If configured, overrides the process soft and hard rlimits (also called ulimits) for file descriptors to the configured value.
Related Name
Default Value
API Name: rlimit_fds
Required: false

Resource Management

Cgroup V1 BLKIO Weight

Description: Weight for the read I/O requests issued by this role, enforced by the Linux kernel under cgroup v1. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 100 and 1000. Defaults to 1000 for processes not managed by Cloudera Manager.
Related Name: blkio.weight
Default Value: 500
API Name: rm_blkio_weight
Required: true

Cgroup V1 CPU Shares

Description: Number of CPU shares to assign to this role, enforced by the Linux kernel under cgroup v1. The greater the number of shares, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 2 and 262144. Defaults to 1024 for processes not managed by Cloudera Manager.
Related Name: cpu.shares
Default Value: 1024
API Name: rm_cpu_shares
Required: true

Cgroup V2 CPU Weight

Description: Weight of CPU resources to assign to this role, enforced by the Linux kernel under cgroup v2. The greater the weight, the larger the share of the host's CPUs that will be given to this role when the host experiences CPU contention. Must be between 1 and 10000. Defaults to 100.
Related Name: cpu.weight
Default Value: 100
API Name: rm_cpu_weight
Required: true

Custom Control Group Resources (overrides Cgroup settings)

Description: Custom control group resources to assign to this role, which will be enforced by the Linux kernel. These resources should exist on the target hosts, otherwise an error will occur when the process starts. Use the same format as used for arguments to the cgexec command: resource1,resource2:path1 or resource3:path2 For example: 'cpu,memory:my/path blkio:my2/path2' ***These settings override other cgroup settings.***
Related Name: custom.cgroups
Default Value
API Name: rm_custom_resources
Required: false

Cgroup V2 I/O Weight

Description: Weight for the I/O requests issued by this role, enforced by the Linux kernel under cgroup v2. The greater the weight, the higher the priority of the requests when the host experiences I/O contention. Must be between 1 and 10000. Defaults to 100.
Related Name: io.weight
Default Value: 100
API Name: rm_io_weight
Required: true

Cgroup V1 Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel under cgroup v1. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_hard_limit_v1
Required: true

Cgroup V2 Memory Hard Limit

Description: Hard memory limit to assign to this role, enforced by the Linux kernel under cgroup v2. When the limit is reached, the kernel will reclaim pages charged to the process. If reclaiming fails, the kernel may kill the process. Both anonymous and page cache pages contribute to the limit. Use a value of 'max' to specify no limit. By default, processes not managed by Cloudera Manager will have no limit. If the value is 'max', Cloudera Manager will not monitor Cgroup memory usage, and some charts will show 'No Data'.
Related Name: memory.max
Default Value: -1 MiB
API Name: rm_memory_hard_limit_v2
Required: true

Cgroup V1 Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel under cgroup v1. When the limit is reached, the kernel will reclaim pages charged to the process if and only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous as well as page cache pages contribute to the limit. Use a value of -1 to specify no limit. By default processes not managed by Cloudera Manager will have no limit. If the value is -1, Cloudera Manager will not monitor Cgroup memory usage therefore some of the charts will show 'No Data'
Related Name: memory.soft_limit_in_bytes
Default Value: -1 MiB
API Name: rm_memory_soft_limit_v1
Required: true

Cgroup V2 Memory Soft Limit

Description: Soft memory limit to assign to this role, enforced by the Linux kernel under cgroup v2. When the limit is reached, the kernel will reclaim pages charged to the process only if the host is facing memory pressure. If reclaiming fails, the kernel may kill the process. Both anonymous and page cache pages contribute to the limit. Use a value of 'max' to specify no limit. By default, processes not managed by Cloudera Manager will have no limit. If the value is 'max', Cloudera Manager will not monitor Cgroup memory usage, and some charts will show 'No Data'.
Related Name: memory.high
Default Value: -1 MiB
API Name: rm_memory_soft_limit_v2
Required: true

Security

Enable TLS/SSL for Metering V2 Server

Description: Encrypt communication between clients and Metering V2 Server using Transport Layer Security (TLS) (formerly known as Secure Socket Layer (SSL)).
Related Name: ssl_enabled
Default Value: false
API Name: ssl_enabled
Required: false

Metering V2 Server TLS/SSL Server CA Certificate (PEM Format)

Description: The path to the TLS/SSL file containing the certificate of the certificate authority (CA) and any intermediate certificates used to sign the server certificate. Used when Metering V2 Server is acting as a TLS/SSL server. The certificate file must be in PEM format, and is usually created by concatenating all of the appropriate root and intermediate certificates.
Related Name: ssl.cacert.location
Default Value
API Name: ssl_server_ca_certificate_location
Required: false

Metering V2 Server TLS/SSL Server Certificate File (PEM Format)

Description: The path to the TLS/SSL file containing the server certificate key used for TLS/SSL. Used when Metering V2 Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: ssl.cert.location
Default Value
API Name: ssl_server_certificate_location
Required: false

Metering V2 Server TLS/SSL Server Private Key File (PEM Format)

Description: The path to the TLS/SSL file containing the private key used for TLS/SSL. Used when Metering V2 Server is acting as a TLS/SSL server. The certificate file must be in PEM format.
Related Name: ssl.privatekey.location
Default Value
API Name: ssl_server_privatekey_location
Required: false

Metering V2 Server TLS/SSL Private Key Password

Description: The password for the private key in the Metering V2 Server TLS/SSL Server Certificate and Private Key file. If left blank, the private key is not protected by a password.
Related Name
Default Value
API Name: ssl_server_privatekey_password
Required: false

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Parameter Validation: Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/dbus-credentials.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/dbus-credentials.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_conf/dbus-credentials.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/meteringv2.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/meteringv2.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_conf/meteringv2.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/ssl.properties

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/ssl.properties parameter.
Related Name
Default Value: false
API Name: role_config_suppression_conf/ssl.properties_role_safety_valve
Required: true

Suppress Parameter Validation: Metering V2 Server Log Directory

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server Log Directory parameter.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Parameter Validation: DBUS Access Key ID

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Access Key ID parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.access.key.id
Required: true

Suppress Parameter Validation: DBUS Access Secret Key

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Access Secret Key parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.access.secret.key
Required: true

Suppress Parameter Validation: DBUS Access Secret Key Algorithm

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Access Secret Key Algorithm parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.access.secret.key.algo
Required: true

Suppress Parameter Validation: DBUS App Name

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS App Name parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.appname
Required: true

Suppress Parameter Validation: DBUS Host

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Host parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.host
Required: true

Suppress Parameter Validation: DBUS HTTPS Proxy

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS HTTPS Proxy parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.https.proxy
Required: true

Suppress Parameter Validation: DBUS Partition Key

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Partition Key parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.partition.key
Required: true

Suppress Parameter Validation: DBUS Proxy Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Proxy Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.proxy.password
Required: true

Suppress Parameter Validation: DBUS Proxy URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Proxy URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.proxy.url
Required: true

Suppress Parameter Validation: DBUS Proxy User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Proxy User parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.proxy.user
Required: true

Suppress Parameter Validation: DBUS Scheme

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Scheme parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.scheme
Required: true

Suppress Parameter Validation: DBUS Stream

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the DBUS Stream parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.stream
Required: true

Suppress Parameter Validation: Region

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Region parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.region
Required: true

Suppress Parameter Validation: Metering V2 Server Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2_server_role_env_safety_valve
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Helper Port

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Helper Port parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_helper_port
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write URL parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Remote Write Username parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_exporters
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_extensions
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_processors
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_receivers
Required: true

Suppress Parameter Validation: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_service
Required: true

Suppress Parameter Validation: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the OpenTelemetry Collector Service Section parameter.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Parameter Validation: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Custom Control Group Resources (overrides Cgroup settings) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Parameter Validation: Role Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Role Triggers parameter.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Parameter Validation: Metering V2 Server TLS/SSL Server CA Certificate (PEM Format)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server TLS/SSL Server CA Certificate (PEM Format) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_ca_certificate_location
Required: true

Suppress Parameter Validation: Metering V2 Server TLS/SSL Server Certificate File (PEM Format)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server TLS/SSL Server Certificate File (PEM Format) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_certificate_location
Required: true

Suppress Parameter Validation: Metering V2 Server TLS/SSL Server Private Key File (PEM Format)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server TLS/SSL Server Private Key File (PEM Format) parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_privatekey_location
Required: true

Suppress Parameter Validation: Metering V2 Server TLS/SSL Private Key Password

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Server TLS/SSL Private Key Password parameter.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_privatekey_password
Required: true

Suppress Health Test: Audit Pipeline Test

Description: Whether to suppress the results of the Audit Pipeline Test heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_audit_health
Required: true

Suppress Health Test: File Descriptors

Description: Whether to suppress the results of the File Descriptors heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_file_descriptor
Required: true

Suppress Health Test: Host Health

Description: Whether to suppress the results of the Host Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_host_health
Required: true

Suppress Health Test: Log Directory Free Space

Description: Whether to suppress the results of the Log Directory Free Space heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_log_directory_free_space
Required: true

Suppress Health Test: Otelcol Health

Description: Whether to suppress the results of the Otelcol Health heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_otelcol_health
Required: true

Suppress Health Test: Process Status

Description: Whether to suppress the results of the Process Status heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_scm_health
Required: true

Suppress Health Test: Swap Memory Usage

Description: Whether to suppress the results of the Swap Memory Usage heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_swap_memory_usage
Required: true

Suppress Health Test: Swap Memory Usage Rate Beta

Description: Whether to suppress the results of the Swap Memory Usage Rate Beta heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_swap_memory_usage_rate
Required: true

Suppress Health Test: Unexpected Exits

Description: Whether to suppress the results of the Unexpected Exits heath test. The results of suppressed health tests are ignored when computing the overall health of the associated host, role or service, so suppressed health tests will not generate alerts.
Related Name
Default Value: false
API Name: role_health_suppression_meteringv2_meteringv2_server_unexpected_exits
Required: true

Service-Wide

Advanced

Metering V2 Service Environment Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, key-value pairs (one on each line) to be inserted into a role's environment. Applies to configurations of all roles in this service except client configuration.
Related Name
Default Value
API Name: METERINGV2_service_env_safety_valve
Required: false

System Group

Description: The group that this service's processes should run as.
Related Name
Default Value: metering
API Name: process_groupname
Required: true

System User

Description: The user that this service's processes should run as.
Related Name
Default Value: metering
API Name: process_username
Required: true

Monitoring

Enable Service Level Health Alerts

Description: When set, Cloudera Manager will send alerts when the health of this service reaches the threshold specified by the EventServer setting eventserver_health_events_alert_threshold
Related Name
Default Value: true
API Name: enable_alerts
Required: false

Enable Configuration Change Alerts

Description: When set, Cloudera Manager will send alerts when this entity's configuration changes.
Related Name
Default Value: false
API Name: enable_config_alerts
Required: false

Service Triggers

Description

The configured triggers for this service. This is a JSON-formatted list of triggers. These triggers are evaluated as part as the health system. Every trigger expression is parsed, and if the trigger condition is met, the list of actions provided in the trigger expression is executed. Each trigger has the following fields:

triggerName (mandatory) - The name of the trigger. This value must be unique for the specific service.
triggerExpression (mandatory) - A tsquery expression representing the trigger.
streamThreshold (optional) - The maximum number of streams that can satisfy a condition of a trigger before the condition fires. By default set to 0, and any stream returned causes the condition to fire.
enabled (optional) - By default set to 'true'. If set to 'false', the trigger is not evaluated.
expressionEditorConfig (optional) - Metadata for the trigger editor. If present, the trigger should only be edited from the Edit Trigger page; editing the trigger here can lead to inconsistencies.

For example, the following JSON formatted trigger fires if there are more than 10 DataNodes with more than 500 file descriptors opened:

[{"triggerName": "sample-trigger",
  "triggerExpression": "IF (SELECT fd_open WHERE roleType = DataNode and last(fd_open) > 500) DO health:bad",
  "streamThreshold": 10, "enabled": "true"}]

Related Name

Default Value

[]

API Name

service_triggers

Required

true

Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: For advanced use only, a list of derived configuration properties that will be used by the Service Monitor instead of the default ones.
Related Name
Default Value
API Name: smon_derived_configs_safety_valve
Required: false

Other

Base data directory - DO NOT CHANGE

Description: DO NOT CHANGE
Related Name: meteringv2.data.path
Default Value: /var/metering
API Name: meteringv2.data.path
Required: true

Suppressions

Suppress Configuration Validator: CDH Version Validator

Description: Whether to suppress configuration warnings produced by the CDH Version Validator configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_cdh_version_validator
Required: true

Suppress Configuration Validator: Deploy Directory

Description: Whether to suppress configuration warnings produced by the Deploy Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_client_config_root_dir
Required: true

Suppress Configuration Validator: Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/dbus-credentials.properties

Description: Whether to suppress configuration warnings produced by the Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/dbus-credentials.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_conf/dbus-credentials.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/meteringv2.properties

Description: Whether to suppress configuration warnings produced by the Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/meteringv2.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_conf/meteringv2.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/ssl.properties

Description: Whether to suppress configuration warnings produced by the Metering V2 Server Advanced Configuration Snippet (Safety Valve) for conf/ssl.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_conf/ssl.properties_role_safety_valve
Required: true

Suppress Configuration Validator: Metering V2 Server Log Directory

Description: Whether to suppress configuration warnings produced by the Metering V2 Server Log Directory configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_log_dir
Required: true

Suppress Configuration Validator: Metering V2 Client Advanced Configuration Snippet (Safety Valve) for meteringv2-conf/meteringv2-client.properties

Description: Whether to suppress configuration warnings produced by the Metering V2 Client Advanced Configuration Snippet (Safety Valve) for meteringv2-conf/meteringv2-client.properties configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2-conf/meteringv2-client.properties_client_config_safety_valve
Required: true

Suppress Configuration Validator: DBUS Access Key ID

Description: Whether to suppress configuration warnings produced by the DBUS Access Key ID configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.access.key.id
Required: true

Suppress Configuration Validator: DBUS Access Secret Key

Description: Whether to suppress configuration warnings produced by the DBUS Access Secret Key configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.access.secret.key
Required: true

Suppress Configuration Validator: DBUS Access Secret Key Algorithm

Description: Whether to suppress configuration warnings produced by the DBUS Access Secret Key Algorithm configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.access.secret.key.algo
Required: true

Suppress Configuration Validator: DBUS App Name

Description: Whether to suppress configuration warnings produced by the DBUS App Name configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.appname
Required: true

Suppress Configuration Validator: DBUS Host

Description: Whether to suppress configuration warnings produced by the DBUS Host configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.host
Required: true

Suppress Configuration Validator: DBUS HTTPS Proxy

Description: Whether to suppress configuration warnings produced by the DBUS HTTPS Proxy configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.https.proxy
Required: true

Suppress Configuration Validator: DBUS Partition Key

Description: Whether to suppress configuration warnings produced by the DBUS Partition Key configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.partition.key
Required: true

Suppress Configuration Validator: DBUS Proxy Password

Description: Whether to suppress configuration warnings produced by the DBUS Proxy Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.proxy.password
Required: true

Suppress Configuration Validator: DBUS Proxy URL

Description: Whether to suppress configuration warnings produced by the DBUS Proxy URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.proxy.url
Required: true

Suppress Configuration Validator: DBUS Proxy User

Description: Whether to suppress configuration warnings produced by the DBUS Proxy User configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.proxy.user
Required: true

Suppress Configuration Validator: DBUS Scheme

Description: Whether to suppress configuration warnings produced by the DBUS Scheme configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.scheme
Required: true

Suppress Configuration Validator: DBUS Stream

Description: Whether to suppress configuration warnings produced by the DBUS Stream configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.dbus.stream
Required: true

Suppress Configuration Validator: Region

Description: Whether to suppress configuration warnings produced by the Region configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2.region
Required: true

Suppress Configuration Validator: Metering V2 Server Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the Metering V2 Server Environment Advanced Configuration Snippet (Safety Valve) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_meteringv2_server_role_env_safety_valve
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Exporters Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Exporters Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_exporters
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Extensions Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Extensions Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_extensions
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Helper Port

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Helper Port configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_helper_port
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Processors Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Processors Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_processors
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Receivers Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Receivers Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_receivers
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Password

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_password
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write URL

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write URL configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_url
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Remote Write Username

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Remote Write Username configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_remote_write_user
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Exporters Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_exporters
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Extensions Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_extensions
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Processors Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_processors
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Receivers Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_receivers
Required: true

Suppress Configuration Validator: Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section

Description: Whether to suppress configuration warnings produced by the Real-Time Monitoring for Jobs / Queries with OpenTelemetry - Service Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_rtm_logs_service
Required: true

Suppress Configuration Validator: OpenTelemetry Collector Service Section

Description: Whether to suppress configuration warnings produced by the OpenTelemetry Collector Service Section configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_otelcol_service
Required: true

Suppress Configuration Validator: Custom Control Group Resources (overrides Cgroup settings)

Description: Whether to suppress configuration warnings produced by the Custom Control Group Resources (overrides Cgroup settings) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_rm_custom_resources
Required: true

Suppress Configuration Validator: Role Triggers

Description: Whether to suppress configuration warnings produced by the Role Triggers configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_role_triggers
Required: true

Suppress Configuration Validator: Metering V2 Server TLS/SSL Server CA Certificate (PEM Format)

Description: Whether to suppress configuration warnings produced by the Metering V2 Server TLS/SSL Server CA Certificate (PEM Format) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_ca_certificate_location
Required: true

Suppress Configuration Validator: Metering V2 Server TLS/SSL Server Certificate File (PEM Format)

Description: Whether to suppress configuration warnings produced by the Metering V2 Server TLS/SSL Server Certificate File (PEM Format) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_certificate_location
Required: true

Suppress Configuration Validator: Metering V2 Server TLS/SSL Server Private Key File (PEM Format)

Description: Whether to suppress configuration warnings produced by the Metering V2 Server TLS/SSL Server Private Key File (PEM Format) configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_privatekey_location
Required: true

Suppress Configuration Validator: Metering V2 Server TLS/SSL Private Key Password

Description: Whether to suppress configuration warnings produced by the Metering V2 Server TLS/SSL Private Key Password configuration validator.
Related Name
Default Value: false
API Name: role_config_suppression_ssl_server_privatekey_password
Required: true

Suppress Configuration Validator: Gateway Count Validator

Description: Whether to suppress configuration warnings produced by the Gateway Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_gateway_count_validator
Required: true

Suppress Parameter Validation: Base data directory - DO NOT CHANGE

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Base data directory - DO NOT CHANGE parameter.
Related Name
Default Value: false
API Name: service_config_suppression_meteringv2.data.path
Required: true

Suppress Configuration Validator: Metering V2 Server Count Validator

Description: Whether to suppress configuration warnings produced by the Metering V2 Server Count Validator configuration validator.
Related Name
Default Value: false
API Name: service_config_suppression_meteringv2_server_count_validator
Required: true

Suppress Parameter Validation: Metering V2 Service Environment Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Metering V2 Service Environment Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_meteringv2_service_env_safety_valve
Required: true

Suppress Parameter Validation: System Group

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System Group parameter.
Related Name
Default Value: false
API Name: service_config_suppression_process_groupname
Required: true

Suppress Parameter Validation: System User

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the System User parameter.
Related Name
Default Value: false
API Name: service_config_suppression_process_username
Required: true

Suppress Parameter Validation: Service Triggers

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Triggers parameter.
Related Name
Default Value: false
API Name: service_config_suppression_service_triggers
Required: true

Suppress Parameter Validation: Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve)

Description: Whether to suppress configuration warnings produced by the built-in parameter validation for the Service Monitor Derived Configs Advanced Configuration Snippet (Safety Valve) parameter.
Related Name
Default Value: false
API Name: service_config_suppression_smon_derived_configs_safety_valve
Required: true