User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

The following feature is new in Ignition version 8.1.13
Click here to check out the other new features

The Metrics Dashboard allows users to visualize a variety of metrics on their own customizable dashboards. Users may browse and search for any registered metric and add it to a dashboard, expanding the diagnostic capabilities available on the Status page. With the addition of this dashboard, developers can contribute diagnostics to the Status page without any additional UI design.



On this page ...

User Interface

Attributes

Description

Add Metric

Select from a list of available metrics to drag and drop onto the dashboard grid.

Grid Size

Control the number of rows and columns on the grid.
ResetClear all metrics tiles from the current dashboard.
Dashboard DropdownSwitch between saved dashboards.
Save Dashboard DropdownSave changes, rename a saved dashboard, or delete the current dashboard.

Types of Metrics

Gauge

Gauges can be any kind of instant-read measurement, such as the number of megabytes of memory consumed, the count of faulted database connections, or the length of a pending task queue. Gauges are used to display a dynamic number.

PropertyDescription
valueA numeric value.

X/Y

An X/Y metric is a pair of gauges that can be interpreted as a ratio. This is an instant-read gauge on a value that has a maximum, such as heap size or a fixed-size thread pool.

PropertyDescription
valueA numeric value.
maxThe maximum value.

Meter

A meter measures the rate at which something occurs, such as the number of messages sent per second. Users can select the units as well as which of the moving average rates to display.

PropertyDescription
countThe number of events seen.
meanRateThe mean rate, overall.
oneMinuteRateThe one-minute moving average rate.
fiveMinuteRateThe five-minute moving average rate.
fifteenMinuteRateThe fifteen-minute moving average rate.

Histogram

A histogram measures the statistical distribution of values in a stream of data. Hovering over a quantile reveals the value at that quantile.

PropertyDescription
countThe number of values or events seen.
minThe minimum value (in milliseconds).
maxThe maximum value (in milliseconds).
meanThe mean value (in milliseconds).
stdDevThe standard deviation (in milliseconds).
medianThe median value (in milliseconds).

Timer

A timer is used to understand both the frequency of and duration of events. It is a combination of a meter (rate of occurrence) and a histogram (distribution of duration). A timer combines the functions and properties of both a meter and a histogram.

Available Metrics

The table below includes all metrics currently available to view on the Metrics Dashboard. New metrics may be made available with the development of new systems, modules, and features.

MetricDescriptionSizeType
ClockDriftDetector
MetricDescriptionSizeType
driftGaugeThe most recent clock drift, in milliseconds.1x1Gauge
driftTimerA Timer that tracks the distribution of the duration of clock drifts.4x2Timer


databases
MetricDescriptionSizeType
connection-{dbName}

Each connected database will have the following associated metrics:

MetricDescriptionSizeType
active-connectionsCount of active connections.1x1Gauge
queriesMeasures the rate and distribution of query execution.4x2Timer
rowsMeasures how many rows the queries being executed against the given database connection are returning2x2Meter
throughputThroughput of queries per second.1x1Gauge


queriesMeasures the rate and distribution of query execution on all database connections.4x2Timer
ignition
MetricDescriptionSizeType
designer.requestsMeasures the rate and distribution of designer requests.4x2Timer
performance
MetricDescriptionSizeType
committed-non-heapCommitted non-heap memory.1x1Gauge
cpuCPU usage as percent utilized.1x1Gauge
diskDisk used out of total space available.1x1X/Y
heapHeap memory used out of total memory available.1x1X/Y
heap-maxMaximum heap memory.1x1Gauge
heap-usedCurrent heap memory used.1x1Gauge
non-heapCurrent non-heap memory used.1x1Gauge
non-heap-pctNon-heap memory used out of total non-heap memory available.1x1X/Y


uptimeTotal uptime.1x1Gauge
perspective
MetricDescriptionSizeType
bindingsPerspective Binding count.1x1Gauge
componentsPerspective Components count.1x1Gauge
expressionsMeasures the rate and distribution of expressions.4x2Timer
fetchesMeasures the rate and distribution of fetches.4x2Timer
pagesPerspective pages count.1x1Gauge
property-changesMeasures the rate of property changes.2x2Meter
scriptsMeasures the rate and distribution of script executions.4x2Timer
session-{sessionName}Each connected Perspective session will have the following associated metrics:


MetricDescriptionSizeType
expressionsMeasures the rate and distribution of expressions.4x2Timer
fetchesMeasures the rate and distribution of fetches.4x2Timer
messages-receivedCount of messages received.2x2Counter
messages-sentCount of messages sent.2x2Counter
property-changesMeasures the rate of property changes.2x2Meter
queue-lengthCurrent length of queue.1x1Gauge
queue-tasksMeasures the rate and distribution of queued tasks.4x2Timer
reconnectsCount of reconnects,2x2Counter
scriptsMeasures the rate and distribution of script executions.4x2Timer
uptimeTotal uptime for the Perspective session.1x1Gauge


sessionsCount of active sessions.1x1Gauge
viewsCount of views.1x1Gauge
projects
MetricDescriptionSizeType
(projectName).resourcesCount of resources per project.1x1Gauge
countCount of projects.1x1Gauge
disk-syncMeasures the frequency and duration of projects directory synchronization.4x2Timer
savesMeasures the rate and distribution of project saves.4x2Timer
redundancy
MetricDescriptionSizeType
config.updateThroughputRate of updates.2x2Meter
alarmpipelinemanager
MetricDescriptionSizeType
taskSendThroughputRate of tasks sent.2x2Meter
taskRecvThroughputRate of tasks received.2x2Meter
queueSizeCurrent queue size.1x1Gauge


sync.queue_maxMaximum queue size.1x1Gauge
scripts
MetricDescriptionSizeType
gateway
MetricDescriptionSizeType
compileMeasures the rate and distribution of script compiles.4x2Timer
executeMeasures the rate and distribution of script executions.4x2Timer




project-(projectName)
MetricDescriptionSizeType
compileMeasures the rate and distribution of script compiles.4x2Timer
executeMeasures the rate and distribution of script executions.4x2Timer
vision.requestsMeasures the rate and distribution of Vision requests.4x2Timer

Examples

Adding Metrics to a Dashboard

  1. Click Add Metric.
  2. Select a metric from the list and click Add.
  3. Hover over the grid to position the metric.
    A blank metrics dashboard. The user is hovering over the grid preparing to drop a 4 by 2 metrics tile. The area that the metric will be dropped is outlined with a dashed line.
  4. Click to snap the metric to the dashboard. To reposition your metric, you can drag and drop it anywhere else on the grid.


  • No labels