Metrics-server Configuration

Metrics-server ConfigurationMetrics-server Configuration

MetricsPropertiesMetricsProperties

Name:
rsa.metrics.content.content-sync-interval
Default value:
2 minutes
Type:
seconds
Description:
Time interval at which content available should be tried to upload to Elastic-Kibana

Name:
rsa.metrics.content.elastic-health-check-interval
Default value:
1 minute
Type:
seconds
Description:
Time interval at which Elastic and Kibana health should be checked

Name:
rsa.metrics.content.metrics-health-check-interval
Default value:
30 minutes
Type:
seconds
Description:
Time interval at which metrics collection health for NetWitness services should be checked

Name:
rsa.metrics.content.orchestration-sync-interval
Default value:
30 Seconds
Type:
seconds
Description:
Interval at which orchestration-server should be queried to get deployment details

Name:
rsa.metrics.content.overwrite-index-template
Default value:
false
Type:
boolean
Description:
Controls if NW index template need to be overridden

Name:
rsa.metrics.content.saved-objects-created
Default value:
false
Type:
boolean
Description:
Whether to create saved objects

AlertProcessingPropertiesAlertProcessingProperties

Name:
rsa.metrics.elastic.alert.metrics-interval
Default value:
900
Type:
seconds
Description:
Duration (in seconds) after which Alarm metrics is uploaded to elastic

Name:
rsa.metrics.elastic.alert.retry-delay
Default value:
1
Type:
seconds
Description:
Interval between subsequent retries

Name:
rsa.metrics.elastic.alert.wait-time
Default value:
1
Type:
seconds
Description:
Wait time post which, first retry attempt on Alert Notification will be done

Name:
rsa.metrics.elastic.alert.work-interval
Default value:
60
Type:
seconds
Description:
Frequency (in seconds) how often Alerts need to collected from Elastic

ElasticRetentionPropertiesElasticRetentionProperties

Name:
rsa.metrics.elastic.data.retention.alert-retention-threshold
Default value:
60
Type:
seconds
Description:
Time duration (in days) for which alerts need to be retained

Name:
rsa.metrics.elastic.data.retention.allocated-size
Default value:
100
Type:
bytes
Description:
Disk space permissible to be used for NetWitness indexes in Elastic

Name:
rsa.metrics.elastic.data.retention.time-retention-frequency
Default value:
4
Type:
seconds
Description:
Interval between invocations of the time based retention job

Name:
rsa.metrics.elastic.data.retention.time-threshold
Default value:
30
Type:
seconds
Description:
Time (in days) for which Additional Telemetry data needs to be retained

ElasticPropertiesElasticProperties

Name:
rsa.metrics.elastic.host
Default value:
Type:
string
Description:
Host Elastic node/cluster is running on

Name:
rsa.metrics.elastic.password
Default value:
Type:
string
Description:
Password for Elastic

Name:
rsa.metrics.elastic.port
Default value:
9200
Type:
integer
Description:
Port Elastic node/cluster is running on

Name:
rsa.metrics.elastic.secure
Default value:
true
Type:
boolean
Description:
Secure to decide protocol for Elastic

Name:
rsa.metrics.elastic.username
Default value:
Type:
string
Description:
Username to connect Elastic

Name:
rsa.metrics.elastic.verify-hostname
Default value:
false
Type:
boolean
Description:
Whether to verify Elastic hostname on SSL validation

ElasticClientCertAuthenticatorPropertiesElasticClientCertAuthenticatorProperties

Name:
rsa.metrics.elastic.security.authenticator.
clientcert.http-enabled
Default value:
false
Type:
boolean
Description:
Whether HTTP authentication requests are enabled

Name:
rsa.metrics.elastic.security.authenticator.clientcert.order
Default value:
0
Type:
integer
Description:
Numerical order of this authentication domain

Name:
rsa.metrics.elastic.security.authenticator.clientcert.
roles-attribute
Default value:
Type:
string
Description:
DN attribute in X509 certificate that identifies role of the subject principal. In NW product suite, username is mapped to a role name in elasticsearch

Name:
rsa.metrics.elastic.security.authenticator.clientcert.
transport-enabled
Default value:
false
Type:
boolean
Description:
Whether authentication enabled at Transport level

Name:
rsa.metrics.elastic.security.authenticator.clientcert.
username-attribute
Default value:
Type:
string
Description:
DN attribute in X509 Certificate that identifies subject principal (username), defaults to 'cn' (Common name)

ElasticJwtAuthenticatorPropertiesElasticJwtAuthenticatorProperties

Name:
rsa.metrics.elastic.security.authenticator.jwt.http-enabled
Default value:
false
Type:
boolean
Description:
Whether HTTP authentication requests are enabled

Name:
rsa.metrics.elastic.security.authenticator.jwt.jwt-header
Default value:
Type:
string
Description:
Authentication backend defines how to validate username or credentials, this is specific to authenticator

Name:
rsa.metrics.elastic.security.authenticator.jwt.order
Default value:
0
Type:
integer
Description:
Numerical order of this authentication domain

Name:
rsa.metrics.elastic.security.authenticator.jwt.roles-key
Default value:
Type:
string
Description:
Key name in the JWT claim that contains to user roles

Name:
rsa.metrics.elastic.security.authenticator.jwt.signing-key
Default value:
Type:
string
Description:
Public key from the issuer certificate that issued JWT token in Base64 format without headers (i.e.without ----BEGIN/END Publi Key-----)

Name:
rsa.metrics.elastic.security.authenticator.jwt.subject-key
Default value:
Type:
string
Description:
Name of the key in JWT claim that identifies subject principal (user)

Name:
rsa.metrics.elastic.security.authenticator.jwt.transport-enabled
Default value:
false
Type:
boolean
Description:
Whether authentication enabled at Transport level

ElasticServicePropertiesElasticServiceProperties

Name:
rsa.metrics.elastic.service.password
Default value:
Type:
string
Description:
Password for nw-service user to be used for metrics collection

KibanaPropertiesKibanaProperties

Name:
rsa.metrics.kibana.base-path
Default value:
Type:
string
Description:

Name:
rsa.metrics.kibana.connection-time-out
Default value:
30
Type:
seconds
Description:
Time to changes connection timeout

Name:
rsa.metrics.kibana.host
Default value:
Type:
string
Description:
Host Kibana node/cluster is running on

Name:
rsa.metrics.kibana.password
Default value:
Type:
string
Description:
Password for kibana

Name:
rsa.metrics.kibana.port
Default value:
0
Type:
integer
Description:
Port Kibana node/cluster is running on

Name:
rsa.metrics.kibana.secure
Default value:
false
Type:
boolean
Description:
Secure to decide protocol for Kibana

Name:
rsa.metrics.kibana.username
Default value:
Type:
string
Description:
Username to connect kibana

Name:
rsa.metrics.kibana.verify-hostname
Default value:
false
Type:
boolean
Description:
Whether to verify kibana hostname on SSL validation

MetricsRetryPropertiesMetricsRetryProperties