Setting the Server Metrics Publisher

The server performance metrics can be used to report, monitor, and configure the server’s health and limits. The collected metrics may include the following information:

  • Long polling, WebSocket, and total number of connections
  • CPU loading percentage
  • Maximum, size, and used Heap Bytes
  • Subscription alerts, users, and total
  • Number of parallel data loading and live threads
  • Average data load time or refresh rate

 

You can configure the following properties in the Panopticon.properties file located in the AppData folder or /etc/panopticon/appdata:

   
Property Server Metrics

Attribute

metrics.authorization.level

Description

Specifies the required authorization level to get server metrics. Available values
are ANONYMOUS, VIEWER, DESIGNER, ADMINISTRATOR.

NOTE: This property is case sensitive.

Default Value

ADMINISTRATOR

Property

Server Metrics

Attribute

metrics.collection.rate

Description

Specifies the rate at which metrics are collected in milliseconds.

Default Value

1000

Property

Server Metrics

Attribute

metrics.file.flush.rate

Description

Specifies how often metrics should be saved to disk in milliseconds. Only used if the metrics.publisher.type is set to FILE.

Default Value

10000

Property

Server Metrics

Attribute

metrics.memory.queue.size

Description

Specifies how many metric entries are stored in memory. When the number of metrics goes above the specified value, the oldest value is removed to make room for the newest one (FIFO). Only used if the metrics.publisher.type is set to MEMORY.

Default Value

100

Property

Server Metrics

Attribute

metrics.publisher.configuration

Description

Specifies the id for which metric publisher configuration to use.

Default Value

 

Property

Server Metrics

Attribute

metrics.publisher.type

Description

Specifies the current metric publisher that is used. Available values are NONE, MEMORY, FILE, EMAIL, INFLUX_DB, JDBC, KAFKA, KDB, MQTT, REST, TEXT.

Default Value

MEMORY

 

 

 

(c) 2013-2024 Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support