Follow

Meter - Configuration File

NOTE On October 11, 2016, BMC released Meter Version 4.4.1 which changed the name of the meter from boundary-meter to truesight-meter. This article reflects the change. If you are using a meter version prior to 4.4.1, then you will need to reference boundary-meter instead of truesight-meter in the operations discussed in this article.

The Meter configuration file is located at

Unix/Linux based systems

/etc/truesight/meter.conf

Windows based systems

On 32-bit systems (Meter 32-bit version) or 64-bit systems (Meter 64-bit version):

\Program Files\truesight\meter.conf

On 64-bit systems (Meter 32-bit version):

\Program Files(x86)\truesight\meter.conf

In practice you should never have to edit this file but if you require more advanced tuning of the meter you can alter the configuration file then restart the meter - see this article for restart instructions on different platforms.

The file format is standard JSON, but follows the conventions of earlier meter releases. The following JSON keys are allowed:

debug
Enables extra debugging (values 1-4, 0 disables). The default value is 0.

http_max_log_kb
Max file size in KB when logging http debug data. The default value is 1024.

premium_api.enable

Enables or disables access to the Premium API. The default value is false.

premium_api.token
The API token for accessing the Premium API.

premium_api.poll_interval_ms
The amount of time between collecting metrics. The default value is 1000.

premium_api.send_interval_ms
The amount of time to batch metrics before forwarding to the API. The default value is 4000.

premium_api.max_backlog
The maximum number of metrics that will be queued between send intervals. The default value is 1000.

premium_api.control_interval_ms
Interval between polling for control/heartbeat updates. The default value is 2000.

premium_api.backoff_s
The amount of time to backoff if there is an error pushing metrics to the API. The default value is 120.

premium_api.plaintext
Determines whether to access the Premium API HTTP (true) or HTTPS (false). The default value is false.

premium_api.compress
Determines whether to enable HTTP compression accessing the Enterprise API. The default value is true.

premium_api.host
The hostname of the Premium API endpoint. The default value is api.truesight.bmc.com.

premium_api.metadata_interval_ms
The amount of time between checking for metadata updates. The default value is 30000.

premium_api.port
Override the default port for accessing the Premium API. The default value is 443.

premium_api.metrics_prefixes
Forwards all local metrics with given prefix. For example, specifying "statsd" will forward all statsd metrics. Specifying 'system.os.loadavg' will forward all system load average metrics.

premium_api.metrics_map
Maps local metrics to different premium metric names. Metrics are specified with a source, followed by the metric name. For example, if you expect a metric from the statsd sink called "my.metric", the source name would be "statsd.my.metric". The entry "statsd.my.metric": { "name": "MY_METRIC" } would remap a local statsd metric to a premium metric called MY_METRIC. Supported sources are 'system' for internal metrics, 'statsd', 'graphite' and 'collectd'.

premium_api.tags
A list of tags to be sent as metadata.

http_proxy.enable

Enables or disables use of an HTTP proxy server. The default value is false.

http_proxy.hostname
The name or web address of a proxy server if one is to be used.

http_proxy.port
The port of the proxy server. The default value is 8080.

http_proxy.type
Can be either 'http' or 'socks5'. The default value is http.

http_proxy.user
User name if required for proxy login.

http_proxy.password
Password if required for proxy login.

http_proxy.auth
Can be either 'basic', 'digest', or 'ntlm'. The default value is basic.

sdk.count_per_route

Enable (true) or disable (false) sending per route request count measures. The default value is true.

sdk.cpu_time_per_route
Enable (true) or disable (false) sending per route cpu time measures. The default value is false.

sdk.resp_time_per_route
Enable (true) or disable (false) sending per route response time measures. The default value is false.

sdk.resp_time_threshold
The lower limit of response time in milliseconds for sending route level data - responses which take more time than this setting can be sent to the backend. Note: there is a server side threshold also for this value, setting the client side threshold lower than the server side threshold will have no effect as the data will be thrown away on the server side. The server threshold is 100 ms. The default value is 10.

sdk.max_reported_routes
The maximum number of reported routes by the meter. Only the top N response times will be reported. The default value is 10.

sdk.route_response_time_sort_by
The aggregate criteria by which the meter will sort the top routes. Valid aggregation functions are max, mean and count. The default value is max.

sdk.file
The Unix domain socket path for the SDK ingress on Linux/Unix. The default value is /tmp/gd.agent.sock.

sdk.port
The UDP socket port for the SDK ingress on Windows. The default value is 26873.

tls.skip_validation
Enables or disables validating server-side TLS certificates. This is useful for debugging on-premise installations. The default value is false.

privileges.plugin_user
Sets the user to run plugins as. The default value is boundary.

privileges.meter_user
Sets the user to run the main meter process as. The default value is nobody.

 

 

 

 

 


The settings below are only for Boundary Enterprise, you should not change any of those unless instructed by Boundary Technical Support.


ipfix_sink.enable
Enables or disables listening for IPFIX flow metrics. The default value is false.

collector.enable

Enables or disables sending IPFIX flow data to Boundary Enterprise. The default value is false.

collector.collectors
List of collectors to try for sending IPFIX flow data.

collector.mode
IPFIX data format (biflow or topk). The default value is biflow.

collector.msg_burst_ms
Minimum interval between sending IPFIX messages. The default value is 100.

collector.msg_timeout_s
Amount of IPFIX messages to queue before discarding if the IPFIX collector is down. The default value is 15.

collector.certfile
SSL Certificate file to use for authenticating with the IPFIX collector. The default value is cert.pem.

collector.cafile
SSL CA Certificate file to use for authenticating with the IPFIX collector. The default value is ca.pem.

collector.keyfile
SSL Key file to use for authenticating with the IPFIX collector. The default value is key.pem.

enterprise_api.enable
Enables or disables access to the Enterprise API. The default value is false.

enterprise_api.api_key
The API key for accessing the Enterprise API.

enterprise_api.org_id
The Organization ID for accessing the Enterprise API.

enterprise_api.host
The hostname of the Enterprise API endpoint. The default value is api.boundary.com.

enterprise_api.plaintext
Determines whether to access the Enterprise API HTTP (true) or HTTPS (false). The default value is false.

enterprise_api.compress
Determines whether to enable HTTP compression accessing the Enterprise API. The default value is true.

enterprise_api.port
Override the default port for accessing the Enterprise API. The default value is 443.






The settings below are for features, which are not yet enabled or tested. Please do not change them - it is for future use


collectd_sink.enable
Enables or disables listening for collectd metrics. Collectd metrics are automatically prefixed internally with 'collectd.'. The default value is false.

collectd_sink.port
Override the default port for listening for collectd metrics. The default value is 25826.

statsd_sink.enable
Enables or disables listening for statsd metrics. Statsd metric names are automatically prefixed interally with 'statsd.'. The default value is false.

statsd_sink.port
Override the default port for listening for statsd metrics. The default value is 8125.

Have more questions? Submit a request