Overview

Agents Specification

Platforms Specification

Examples

Kafka

Targeting Kafka version 1.0.

Attributes

Attribute	Description
Cluster ID	User-defined in agent configuration
Node ID	Value of the `kafka.server:type=app-info,id=ID` JMX MBean.
Agent Version	Provided by the agent
Data Store Node Version	Value of the `kafka.server:type=app-info` JMX MBean.
Node's Shard List	Need to consult each topic’s partition map zookeeper node (`/brokers/topics/PARTITION`).
Shard ID	Derived by combining topic and partition: `TOPIC/PARTITION`.
Shard replication state	Need to consult each topic’s partition map zookeeper node (`/brokers/topics/PARTITION`).
Shard commit offset	Unit: offset. Value: topic offsets.
Shard replication lag	Unit: number of messages. Value: `kafka.server:type=FetcherLagMetrics,name=ConsumerLag,clientId=ReplicaFetcherThread-0-LEADER_ID,topic=TOPIC,partition=PARTITON_ID` JMX MBean.

Behaviours

Behaviour	Description
Clustering	Set of Kafka broker nodes
Replication	Kafka brokers automatically replicate topics
Sharding of Data	Each topic's partition is an independent shard
Shards Automated Failover	Kafka provides automated failover
Agent Actions	Provided by the agent

MongoDB Replica Set

Built targeting MongoDB 3.2.

Attributes

Attribute	Description
Cluster ID	Replica Set ID from `replSetGetStatus`
Node ID	Node name from `replSetGetStatus`
Agent Version	Provided by the agent
Data Store Node Version	From the output of the `buildInfo` command
Node's Shard List	The Replica Set is the only shard
Shard ID	The Replica Set name from `replSetGetStatus`
Shard replication state	The Replica Set node status from `replSetGetStatus`
Shard commit offset	Unit: seconds (since epoch). Value: The most recent oplog timestamp from `replSetGetStatus`.
Shard replication lag	The lag is calculated as the oplog time for the PRIMARY node and the oplog time for the current node as reported by `replSetGetStatus`. If no PRIMARY node is found the lag is not reported. The unit for lag is seconds.

Behaviours

Behaviour	Description
Clustering	The Replica Set is the cluster
Replication	Replica Set provides replication
Sharding of Data	No sharding, the whole Replica Set is considered the one and only shard
Shards Automated Failover	Replica Set provides automated failover
Agent Actions	Provided by the agent

Zookeeper

Built targeting Zookeeper version 3.3.

Attributes

Attribute	Description
Cluster ID	User-defined in agent configuration
Node ID	`serverId` value of the `conf` command output
Agent Version	Provided by the agent
Data Store Node Version	From the output of either `envi` or `srvr` command
Node's Shard List	The Zookeeper Ensemble is the only shard
Shard ID	The Cluster ID
Shard replication state	`Mode` value of the `srvr` command output
Shard commit offset	Unit: offset. Value: the `Zkid` value of the `srvr` command.
Shard replication lag	Unavailable (would need access to the PRIMARY node)

Behaviours

Behaviour	Description
Clustering	The Zookeeper nodes forming the Ensemble
Replication	Zookeeper provides replication
Sharding of Data	No sharding, the whole Ensemble is considered the one and only shard
Shards Automated Failover	Zookeeper Ensemble provides automated failover
Agent Actions	Provided by the agent