View source for IXN/Current/IXNPEGuide/Interaction Server metrics

{{ArticlePEServiceMetrics
|IncludedServiceId=ed7ae447-cc86-42d1-a856-92a802e32dd5
|CRD=PodMonitor
|Port=13131,

13133,

13139
|Endpoint=option '''ixnServer.ports.health''' - default port 13131 - Endpoint: “/health/prometheus/all”

option '''ixnNode.ports.default''' - default port 13133 - Endpoint: “/metrics”

option '''ixnVQNode.ports.health''' - default port 13139 - Endpoint: “/metrics”

'''Note''': The above options are references to ports that match endpoints. Use these options to perform the associated query.
|MetricsUpdateInterval=Default
|MetricsDefined=Yes
|MetricsIntro=This table includes IXN Server metrics and IXN Node metrics. IXN Node metrics begin with the prefix ''ixnnode''.

'''Note''': There are more metrics than the ones listed in the table. However, only the metrics listed in the table are supported.
|PEMetric={{PEMetric
|Metric=ixn_health_info_current_clients
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of clients that are connected to IXN at the moment.
|SampleValue=5
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_current_routers
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of 'connected to' IXN routers.
|SampleValue=1
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_client_count { client_type_name="Agent application" }
|Type=Gauge
|Unit=Amount
|Label=client_type_name. See the metric description for more details.
|MetricDescription=Indicates the number of clients with specified type, connected to IXN.

'''Label descriptions''':

*client_type_name - type of connected clients. Possible values are:
**Unknown
**Proxy
**Agent application
**Media server
**Reporting engine
**Routing engine
**Universal router
**Third party client.

<br />
|SampleValue=101
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_router_total_submitted { router_name="URServer" }
|Type=Counter
|Unit=Amount
|Label=router_name. See the metric description for more details.
|MetricDescription=Indicates the total number of interactions that have been submitted to the router.

'''Label descriptions''':

router_name - the name of the router into which the interactions have been submitted.
|SampleValue=33
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_load_count { router_name="URServer", strategy_name="AAAstarterStrategy", strategy_tenant="1" }
|Type=Gauge
|Unit=Amount
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the number of strategies with specified name loaded into a specified router.

'''Label descriptions''':

*router_name - the name of the router into which the interactions are loaded
*strategy_name - name of strategy
*strategy_tenant - tenant number

<br />
|SampleValue=1
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_router_current_capacity { router_name="URServer" }
|Type=Gauge
|Unit=Amount
|Label=router_name. See the metric description for more details.
|MetricDescription=Indicates the current capacity of a specified router - the number of interactions, not including those already submitted, that can be submitted into the router.

'''Label descriptions''':

router_name - name of router.
|SampleValue=987
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_currently_submitted { router_name="URServer" }
|Type=Gauge
|Unit=Amount
|Label=router_name. See the metric description for more details.
|MetricDescription=Indicates the number of interactions that are in a specified router.

'''Label descriptions''':

router_name - name of router.
|SampleValue=13
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_current_strategies
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates number of strategies which are associated with active submitters.
|SampleValue=11
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_router_max_submitted { router_name="URServer" }
|Type=Gauge
|Unit=Amount
|Label=router_name. See the metric description for more details.
|MetricDescription=Indicates the maximum capacity of specified router - the number of interactions, that can be submitted into the router.

'''Label descriptions''':

*router_name - name of router.

''ixn_health_info_router_max_submitted = ixn_health_info_router_currently_submitted + ixn_health_info_router_current_capacity''

<br />
|SampleValue=1000
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_current_database_requests
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the current database requests queue length.
|SampleValue=0
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_total_database_requests
|Type=Counter
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of processed database requests from IXN application start till current moment.
|SampleValue=75
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_current_database_connections
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the current number of DB connections.
|SampleValue=5
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_total_database_deadlocks
|Type=Counter
|Unit=Amount
|Label=None
|MetricDescription=Indicates the total number of database queries that end up with a deadlock for all the time since IXN started.
|SampleValue=0
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_last_submitted_at { router_name="URServer", strategy_name="AAAStarterToAgent", strategy_tenant="1" }
|Type=Gauge
|Unit=Unix timestamp
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the Unix timestamp when last interaction has been submitted to router for specified strategy.

'''Label descriptions''':

*router_name - name of router;
*strategy_name - name of strategy;
*strategy_tenant - tenant number.

<br />
|SampleValue=1618322383
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_queue_media_waiting_processing { queue_name="AAAstarterQueue", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the current number of interactions with specified media type that are waiting for processing in a specified queue.

'''Label descriptions''':

*queue_name - name of queue;
*queue_tenant - tenant number;
*media_name - media type.

Note: This value is provided in Pulse as well.
|SampleValue=0
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_agent_logged_in_count { agent_tenant="1" }
|Type=Gauge
|Unit=Amount
|Label=agent_tenant. See the metric description for more details.
|MetricDescription=Indicates the current number of logged in agents.

'''Label descriptions''':

agent_tenant - tenant number.
|SampleValue=565
|UsedFor=Workload
}}{{PEMetric
|Metric=ixn_health_info_queue_media_in_router { queue_name="toAgent", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the number of the interactions with specified media type from a specified queue being routed.

'''Label descriptions''':

*queue_name - name of queue
*queue_tenant - tenant number
*media_name - media type
|SampleValue=10
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_queue_media_on_agent { queue_name="toAgent", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the number of the interactions with specified media type from specified queue being handled by agents.

'''Label descriptions''':

*queue_name - name of queue
*queue_tenant - tenant number
*media_name - media type
|SampleValue=5
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_queue_media_current_length { queue_name="toAgent", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the number of interactions with specified media type that are waiting processing in specified queue and were never delivered to agent.

'''Label descriptions''':

*queue_name - name of queue
*queue_tenant - tenant number
*media_name - media type

'''Note''': This value is provided in Pulse as well.
|SampleValue=2
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_queue_media_in_processing { queue_name="toAgent", queue_tenant="1", media_name="chat" }
|Type=Gauge
|Unit=Amount
|Label=queue_name, queue_tenant, media_name. See the metric description for more details.
|MetricDescription=Indicates the sum of the interactions with specified media type from specified queue being routed by routers and being handled by agents.

'''Label descriptions''':

*queue_name - name of queue
*queue_tenant - tenant number
*media_name - media type

''ixn_health_info_queue_media_in_processing = ixn_health_info_queue_media_in_router + ixn_health_info_queue_media_on_agent''

'''Note''': This value is provided in Pulse as well.
|SampleValue=15
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_currently_submitted { router_name="URServer", strategy_name="AAAStarterToAgent", strategy_tenant="1" }
|Type=Gauge
|Unit=Amount
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the number of interactions which are submitted to specified router by specified strategy at the moment.

'''Label descriptions''':

*router_name - name of router
*strategy_name - name of strategy
*strategy_tenant - tenant number
|SampleValue=3
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_current_capacity { router_name="URServer", strategy_name="AAAStarterToAgent", strategy_tenant="1" }
|Type=Gauge
|Unit=Amount
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the number of interactions that can be submitted more to specified router by specified strategy.

'''Label descriptions''':

*router_name - name of router
*strategy_name - name of strategy
*strategy_tenant - tenant number
|SampleValue=197
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixn_health_info_router_strategy_total_submitted { router_name="URServer", strategy_name="AAAStarterToAgent", strategy_tenant="1" }
|Type=Counter
|Unit=Amount
|Label=router_name, strategy_name, strategy_tenant. See the metric description for more details.
|MetricDescription=Indicates the number of interactions that were submitted to specified router by specified strategy since IXN app start till now.

'''Label descriptions''':

*router_name - name of router
*strategy_name - name of strategy
*strategy_tenant - tenant number
|SampleValue=9
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_interactions_pulled_total
|Type=Counter
|Unit=Amount
|Label=strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of the interactions pulled for the specific strategy.

'''Label descriptions''':

strategy - The name of the strategy for which interactions are pulled.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_routing_sessions_current
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the current number of the routing sessions in routing.
|UsedFor=Workload
}}{{PEMetric
|Metric=ixnnode_all_instructions_received_total
|Type=Counter
|Unit=Amount
|Label=None
|MetricDescription=Indicates the total number of instructions (of any type) received from ORS service.<br />
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_routing_instructions_received_total
|Type=Counter
|Unit=Amount
|Label=strategy, type. See the metric description for more details.
|MetricDescription=Indicates the total number of received routing instructions.

'''Label descriptions''':

*strategy - The name of the strategy for which routing instructions is received.
*type - The type of the instruction. It takes values "terminal" and "non-terminal". Terminal instructions are RequestDeliver, RequestPlaceInQueue, RequestPlaceInWorkbin, RequestStopProcessing.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_redis_client_status
|Type=Gauge
|Unit=Status
|Label=redis_client. See the metric description for more details. er".
|MetricDescription=Indicates the status of Redis client.

'''Label descriptions''':

redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".

Value: 

0 - Not Ready

1 - Ready
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_redis_client_errors_total
|Type=Counter
|Unit=Amount
|Label=redis_client. See the metric description for more details.
|MetricDescription=Indicates the total number of errors occurred on Redis client.

'''Label descriptions''':

redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_redis_client_node_status
|Type=Gauge
|Unit=Status
|Label=redis_client, node. See the metric description for more details.
|MetricDescription=Indicates the status of connection to individual nodes of Redis server (in singleton mode matches to ixnnode_redis_client_status).

'''Label descriptions''':

*redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
*node - The node of Redis server for which the metric is present as "host:port".

Value: 

0 - Ready

1 - Not Ready

2 - Wait (so far there have been no connection attempts)
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_redis_client_node_errors_total
|Type=Counter
|Unit=Amount
|Label=redis_client, node. See the metric description for more details.
|MetricDescription=Indicates the total number of errors occurred on individual nodes of Redis client (in singleton mode matches to ixnnode_redis_client_errors_total).

'''Label descriptions''':

*redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
*node - The node of Redis server for which the metric is present as "host:port".
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_redis_commands_completed_total
|Type=Counter
|Unit=Amount
|Label=redis_client, command. See the metric description for more details.
|MetricDescription=Indicates the total number of successfully completed redis commands.

'''Label descriptions''':

*redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
*command - The Redis command for which the metric is present. It takes values "xadd", "xread", "xdel".
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_redis_commands_failed_total
|Type=Counter
|Unit=Amount
|Label=redis_client, command. See the metric description for more details.
|MetricDescription=Indicates the total number of failed redis commands.

'''Label desriptions''':

*redis_client - The Redis client instance for which the metric is present. It takes values "reader" and "writer".
*command - The Redis command for which the metric is present. It takes values "xadd", "xread", "xdel".
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_rq_client_status
|Type=Gauge
|Unit=Status
|Label=rq_node. See the metric description for more details.
|MetricDescription=Indicates the status of connection to RQ Service nodes.

'''Label descriptions''':

rq_node - RQ Service node for which the metric is present.
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_rq_requests_failed_total
|Type=Counter
|Unit=Amount
|Label=type. See the metric description for more details.
|MetricDescription=Indicates the total number of failed requests to RQ Service.

'''Label descriptions''':

type - The type of the failed requests. It takes values "isp_event" - interaction protocol evnts and "ixn_ping" - health check messages.
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_instructions_processing_queue_concurrency_limit
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the maximum number of routing instructions that can be processed in parallel.
|UsedFor=n/a
}}{{PEMetric
|Metric=ixnnode_instructions_processing_queue_size
|Type=Gauge
|Unit=Amount
|Label=type. See the metric description for more details.
|MetricDescription=Indicates the number of instructions received from ORS currently being processed.

'''Label descriptions''':

type - The type of the instruction. It takes values "isp_request" - routing instruction and "ixn_ping" - reply to health check message.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_pull_request_total
|Type=Counter
|Unit=Amount
|Label=strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of RequestPull requests successfully completed by InteractionServer.

'''Label descriptions''':

strategy - The strategy for which interactions are pulled.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_route_request_sent_total
|Type=Counter
|Unit=Amount
|Label=strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of route requests successfully sent to ORS.

'''Label descriptions''':

strategy - The strategy to which requests are sent.
|UsedFor=Workload, Operability
}}{{PEMetric
|Metric=ixnnode_route_request_failed_total
|Type=Counter
|Unit=Amount
|Label=strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of route requests failed to send to ORS.

'''Label descriptions''':

strategy - The strategy to which requests are sent.
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_instructions_processed_by_ixn_current
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of routing instructions currently being processed by IXN Server.
|UsedFor=Workload
}}{{PEMetric
|Metric=ixnnode_interactions_placed_back_total
|Type=Counter
|Unit=Amount
|Label=reason, strategy. See the metric description for more details.
|MetricDescription=Indicates the total number of times an interaction was placed back in queue.

'''Label descriptions''':

*reason - The reason of placing back in queue. It takes values:<br />"StrategyOldQueueRequest" - Strategy explicitly requested to place to valid queue with name (not "BACK") matching the name of queue interaction was pulled from. Set by ORS.<br />"StrategyBackRequest" - Strategy requested placing interaction "BACK" explicitly. Set by ORS.<br />"Implicit" - Strategy did nothing and ORS places interaction back cause there are no instructions for it. Set by ORS.<br />"Error" - ORS places interaction back into queue due to some error regardless of the error source be it strategy itself or any other reason. Set by ORS.<br />"SubmitError" - IXN Node failed to send interaction to ORS and places it back into queue.<br />"Unknown" - The reason was not specified by ORS.
*strategy - The strategy which routed interactions.
|UsedFor=Workload, Error, ORS Error
}}{{PEMetric
|Metric=ixnnode_running_strategies_current
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of the strategies for which interactions currently are being pulled.
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_configured_strategies_current
|Type=Gauge
|Unit=Amount
|Label=None
|MetricDescription=Indicates the number of the strategies read from configuration for which interactions should be pulled.
|UsedFor=Operability
}}{{PEMetric
|Metric=ixnnode_configuration_fetch_errors_total
|Type=Counter
|Unit=Amount
|Label=None
|MetricDescription=Indicates the total number of error occurred while fetching configuration from Configuration Service.
|UsedFor=Error
}}{{PEMetric
|Metric=ixnnode_last_fetched_configuration_timestamp
|Type=Gauge
|Unit=Timestamp
|Label=None
|MetricDescription=Indicates the last time the configuration was successfully fetched from Configuration Service as the number of seconds since January 1 1970 UTC.
|UsedFor=Operability
}}
|AlertsDefined=No
|PEAlert={{PEAlert}}
}}