Software AG Infrastructure 10.7 | webMethods Metering | Configuring the webMethods Metering Agent | webMethods Metering Agent Properties and Environment Variables
 
webMethods Metering Agent Properties and Environment Variables
You can configure the properties and environment variables described in the following table. The properties in the first column can be modified either in the metering.agent.properties file or as Java System properties.
Property
Corresponding Environment Variable
Description
metering.
server.url
METERING_
SERVER_URL
The URL of the metering aggregator server REST API.
metering.
accumulation.period
METERING_
ACCUMULATION_
PERIOD
The period in seconds for which data is accumulated before a log record is produced.
Default: 1800. (30 minutes)
Note:
If you run your product instances in containers, make sure that this period is shorter than the estimated lifespan of the containers. Software AG recommends that you configure this property to at least 300 (5 minutes), but you can adjust this value for short-lived containers. This guarantees that all usage data is accumulated before a container stops running.
metering.
report.period
METERING_
REPORT_PERIOD
The period in seconds after which data is pushed to the metering server.
Use a value that is larger than the metering.accumulation.period property.
Default: 3600 (1 hour)
Note:
If you run your product instances in containers, make sure that this period is shorter than the estimated lifespan of the containers. Software AG recommends that you configure this property to at least 600 (10 minutes), but you can adjust this value for short-lived containers. This guarantees that all usage data is reported before a container stops running.
metering.
proxy.type
METERING_
PROXY_TYPE
Тhe type of the proxy that the metering client uses.
Valid values are:
*DIRECT (default). Indicates that the metering client does not use a proxy.
*HTTP
*SOCKS
metering.
proxy.address
METERING_
PROXY_ADDRESS
The proxy address in a <host>:<port> format that the metering client uses.
Configure this property only if you use a metering proxy.
metering.
proxy.user
METERING_
PROXY_USER
The proxy username that the metering client uses.
Configure this property only if you use a metering proxy with authentication.
By default, HTTP basic authentication is disabled in JVM runtimes for security reasons. To use proxy authentication, you must enable basic authentication by adding the following line in the custom_wrapper.conf file of each product that uses Software AG Metering:
wrapper.java.additional.777=-Djdk.http.auth.tunneling.disabledSchemes=""
metering.
proxy.pass
METERING_
PROXY_PASS
The proxy password that the metering client uses.
Configure this property only if you use a metering proxy with authentication.
Depending on the method that you use to provide a password, ensure that you escape password characters that are specific for the selected method.
Valid characters:
*Letters: A-Z, a-z
*Numbers: 0-9
*Special characters: !@#$%^&*()_+-=[]{}\/?,.<>;
Note:
Passwords cannot contain colon (:) or any regional characters.
metering.
server.connect.
timeout
METERING_
SERVER_CONNECT_
TIMEOUT
Тhe time in milliseconds to establish the initial TCP connection when the metering client calls the server REST endpoint. This is also the time to start the request.
Default: 60000 (1 minute) .
metering.
server.read.
timeout
METERING_
SERVER_READ_
TIMEOUT
The maximum time in milliseconds without data transfer over the TCP connection to the server. This is also the time that it takes for the server to respond. When this time passes, the request fails.
Default: 300000 (5 minutes) .
sag.install.root
SAG_INSTALL_ROOT
The absolute path to the Software AG installation root directory. Use this path only as a Java system property or an environment variable.
metering.
truststore.file
METERING_
TRUSTSTORE_FILE
The absolute path to the metering client truststore that is used for HTTPS connections. Add this value in any of the following cases:
*If you use the webMethods Metering Server on premises (via HTTPS) and the certificates in the truststore do not match the certificates configured in Software AG Runtime (CTP).
*If you use a metering proxy that terminates the SSL connection to the Metering Server in Software AG Cloud.
metering.
truststore.
password
METERING_
TRUSTSTORE_
PASSWORD
The password for the metering client truststore.
Configure this property only if you use a truststore.
metering.
runtime.alias
METERING_
RUNTIME_ALIAS
An alias of the webMethods product instance or a group of instances, for which usage data is measured.
metering.
log.level
METERING_
LOG_LEVEL
The level of log messages that are logged on the console.
Valid values are:
*error - logs only ERROR messages.
*warn (default) - logs ERROR and WARN messages.
*info - logs ERROR, WARN, and INFO messages.
*debug - logs ERROR, WARN, INFO, and DEBUG messages. Use as a Java system property or an environment variable to see the debug messages of the configuration initialization.