Service Configuration Properties: Metrics-server Configuration

Document created by RSA Information Design and Development Employee on Jan 31, 2020Last modified by RSA Information Design and Development Employee on Sep 8, 2020
Version 2Show Document
  • View in full screen mode
 

MetricsProperties

                                                     
NameDefault valueTypeDescription

rsa.metrics.content.content-sync-interval

2 minutes

seconds

Time interval at which content available should be tried to upload to Elastic-Kibana

rsa.metrics.content.elastic-health-check-interval

1 minute

seconds

Time interval at which Elastic and Kibana health should be checked

rsa.metrics.content.metrics-health-check-interval

30 minutes

seconds

Time interval at which metrics collection health for Netwitness services should be checked

rsa.metrics.content.orchestration-sync-interval

30 Seconds

seconds

Interval at which orchestration-server should be queried to get deployment details

rsa.metrics.content.overwrite-index-template

false

boolean

Controls if NW index template need to be overridden

rsa.metrics.content.saved-objects-created

false

boolean

Whether to create saved objects

AlertProcessingProperties

                                         
NameDefault valueTypeDescription

rsa.metrics.elastic.alert.metrics-interval

900

seconds

Duration (in seconds) after which Alarm metrics is uploaded to elastic

rsa.metrics.elastic.alert.retry-delay

1

seconds

Interval between subsequent retries

rsa.metrics.elastic.alert.wait-time

1

seconds

Wait time post which, first retry attempt on Alert Notification will be done

rsa.metrics.elastic.alert.work-interval

60

seconds

Frequency (in seconds) how often Alerts need to collected from Elastic

ElasticRetentionProperties

                                         
NameDefault valueTypeDescription

rsa.metrics.elastic.data.retention.alert-retention-threshold

60

seconds

Time duration (in days) for which alerts need to be retained

rsa.metrics.elastic.data.retention.allocated-size

100

bytes

Disk space permissible to be used for Netwitness indexes in Elastic

rsa.metrics.elastic.data.retention.time-retention-frequency

4

seconds

Interval between invocations of the time based retention job

rsa.metrics.elastic.data.retention.time-threshold

30

seconds

Time (in days) for which Additional Telemetry data needs to be retained

ElasticProperties

                                                     
NameDefault valueTypeDescription

rsa.metrics.elastic.host

 

string

Host Elastic node/cluster is running on

rsa.metrics.elastic.password

 

string

Password for Elastic

rsa.metrics.elastic.port

9200

integer

Port Elastic node/cluster is running on

rsa.metrics.elastic.secure

true

boolean

Secure to decide protocol for Elastic

rsa.metrics.elastic.username

 

string

Username to connect Elastic

rsa.metrics.elastic.verify-hostname

false

boolean

Whether to verify Elastic hostname on SSL validation

ElasticClientCertAuthenticatorProperties

                                               
NameDefault valueTypeDescription

rsa.metrics.elastic.security.authenticator.
clientcert.http-enabled

false

boolean

Whether HTTP authentication requests are enabled

rsa.metrics.elastic.security.authenticator.clientcert.order

0

integer

Numerical order of this authentication domain

rsa.metrics.elastic.security.authenticator.clientcert.
roles-attribute

 

string

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

rsa.metrics.elastic.security.authenticator.clientcert.
transport-enabled

false

boolean

Whether authentication enabled at Transport level

rsa.metrics.elastic.security.authenticator.clientcert.
username-attribute

 

string

DN attribute in X509 Certificate that identifies subject principal (username), defaults to 'cn' (Common name)

ElasticJwtAuthenticatorProperties

                                                           
NameDefault valueTypeDescription

rsa.metrics.elastic.security.authenticator.jwt.http-enabled

false

boolean

Whether HTTP authentication requests are enabled

rsa.metrics.elastic.security.authenticator.jwt.jwt-header

 

string

Authentication backend defines how to validate username or credentials, this is specific to authenticator

rsa.metrics.elastic.security.authenticator.jwt.order

0

integer

Numerical order of this authentication domain

rsa.metrics.elastic.security.authenticator.jwt.roles-key

 

string

Key name in the JWT claim that contains to user roles

rsa.metrics.elastic.security.authenticator.jwt.signing-key

 

string

Public key from the issuer certificate that issued JWT token in Base64 format without headers (i.e.without ----BEGIN/END Publi Key-----)

rsa.metrics.elastic.security.authenticator.jwt.subject-key

 

string

Name of the key in JWT claim that identifies subject principal (user)

rsa.metrics.elastic.security.authenticator.jwt.transport-enabled

false

boolean

Whether authentication enabled at Transport level

ElasticServiceProperties

                       
NameDefault valueTypeDescription

rsa.metrics.elastic.service.password

 

string

Password for nw-service user to be used for metrics collection

KibanaProperties

                                                                 
NameDefault valueTypeDescription

rsa.metrics.kibana.base-path

 

string

 

rsa.metrics.kibana.connection-time-out

30

seconds

Time to changes connection timeout

rsa.metrics.kibana.host

 

string

Host Kibana node/cluster is running on

rsa.metrics.kibana.password

 

string

Password for kibana

rsa.metrics.kibana.port

0

integer

Port Kibana node/cluster is running on

rsa.metrics.kibana.secure

false

boolean

Secure to decide protocol for Kibana

rsa.metrics.kibana.username

 

string

Username to connect kibana

rsa.metrics.kibana.verify-hostname

false

boolean

Whether to verify kibana hostname on SSL validation

MetricsRetryProperties

                             
NameDefault valueTypeDescription

rsa.metrics.retry.retry-attempts

5

integer

The number of times we retry if a service can be configured with the latest configuration.

rsa.metrics.retry.retry-delay

4min

seconds

The delay between successive retry attempts.

TelemetryProperties

                             
NameDefault valueTypeDescription

rsa.telemetry.collect-click-stream-metrics

false

boolean

Controls if the click stream stats are to be collected

rsa.telemetry.config-load-retry-interval

2

seconds

Controls the interval to load the telemetry config

MongoDataRetentionProperties

                                         
NameDefault valueTypeDescription

rsa.telemetry.mongo.data.retention.additional-data-threshold

7

seconds

Time (in days) for which Additional Telemetry data needs to be retained

rsa.telemetry.mongo.data.retention.disk-allocated-size

50

integer

Size of the data (in GB) that is allowed to be consumed by Telemetry data

rsa.telemetry.mongo.data.retention.mandatory-data-threshold

365

seconds

Time (in days) for which Mandatory Telemetry data needs to be retained

rsa.telemetry.mongo.data.retention.size-retention-frequency

1

seconds

Interval between invocations of the storage size based retention job

You are here
Table of Contents > Metrics-server Configuration

Attachments

    Outcomes