Data Governance Server Documentation Index
Configuration Reference Home

StatsD Monitoring Endpoint

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

A StatsD Monitoring Endpoint defines a destination where server metric data should be sent for monitoring in StatsD format.

↓Parent Component
↓Relations from This Component
↓Properties
↓dsconfig Usage

Parent Component

The StatsD Monitoring Endpoint component inherits from the Monitoring Endpoint

Relations from This Component

The following components have a direct aggregation relation from StatsD Monitoring Endpoints:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ enabled  None
↓ hostname
↓ server-port
↓ connection-type
↓ trust-manager-provider

Basic Properties

enabled

Description
Indicates whether this Monitoring Endpoint is enabled for use in the Data Governance Server.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

hostname

Description
The name of the host where this StatsD Monitoring Endpoint should send metric data.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

server-port

Description
Specifies the port number of the endpoint where metric data should be sent.
Default Value
8125
Allowed Values
An integer value. Lower limit is 1. Upper limit is 65535 .
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

connection-type

Description
Specifies the protocol and security that this StatsD Monitoring Endpoint should use to connect to the configured endpoint. StatsD-formatted metrics are typically sent over UDP, but most monitoring applications will accept StatsD metrics sent over TCP, optionally using SSL.
Default Value
unencrypted-udp
Allowed Values
unencrypted-udp - Metric messages will be sent unencrypted using UDP. UDP is less reliable than TCP, since it does not guarantee message delivery.

unencrypted-tcp - Metric messages will be sent unencrypted using TCP. TCP will guarantee message order and delivery once connected with the endpoint.

ssl-over-tcp - Metric messages will be encrypted and sent using SSL over TCP.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

trust-manager-provider

Description
The trust manager provider to use if SSL over TCP is to be used for connection-level security.
Default Value
The Java Runtime Environment's default trust manager will be used
Allowed Values
The DN of any Trust Manager Provider. The associated trust manager provider must exist and must be enabled if SSL is to be used.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Monitoring Endpoints:

dsconfig list-monitoring-endpoints
     [--property {propertyName}] ...

To view the configuration for an existing Monitoring Endpoint:

dsconfig get-monitoring-endpoint-prop
     --endpoint-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Monitoring Endpoint:

dsconfig set-monitoring-endpoint-prop
     --endpoint-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new StatsD Monitoring Endpoint:

dsconfig create-monitoring-endpoint
     --endpoint-name {name}
     --type statsd
     --set enabled:{propertyValue}
     --set hostname:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Monitoring Endpoint:

dsconfig delete-monitoring-endpoint
     --endpoint-name {name}