query-metric

Description

Explore collected monitoring data by forming queries for charts and data.

This tool features commands that can help you interact with the monitoring API. In particular the explore command is a good place to start for discovering the type of data that is available from the Metrics Engine. Also, commands for listing dynamic data like metrics and instances can help you understand valid arguments to supply in queries of the API.

See docs/metrics/index.html for detailed information about metrics and related concepts.

Examples

query-metric

Subcommands

Create a series of hyper-linked HTML files containing charts for a broad range of metrics

The primary purpose of this sub-command is to demonstrate how to interact with the API as well as show what data is available. By default a relatively short time frame and number of data intervals is specified in order to improve this tool's response time. If large numbers of metrics instances, or data points are requested it may the tool a while to finish generating output

Server instances may be specified using several criteria such as location, version, type, and specific instance IDs. Each criteria may specify one or more values that will match a server if any of the values are present. When used together, these criteria form a selection clause in which all the elements must be true. So for example the following --instanceLocation Austin --instanceType identity-data-store --instanceType proxy would select all Identity Proxy and Identity Data Store instances in Austin

See docs/metrics/index.html for detailed information about metrics and related concepts

query-metric explore --httpPort 8080 --outputDir explore-output

query-metric explore --httpPort 8080 --instanceType proxy \
     --instanceLocation Austin --metric response-time --metric throughput \
     "--startTime -2w"

Query for a single chart or data table for a specific metric

Server instances may be specified using several criteria such as location, version, type, and specific instance IDs. Each criteria may specify one or more values that will match a server if any of the values are present. When used together, these criteria form a selection clause in which all the elements must be true. So for example the following --instanceLocation Austin --instanceType identity-data-store --instanceType proxy would select all Identity Proxy and Identity Data Store instances in Austin

query-metric query --hostname localhost --httpPort 8080 \
     --username cn=user1,cn=api-users --password secret --metric response-time \
     --statistic histogram --pivot instance --startTime -5m

query-metric query --hostname localhost --httpPort 8080 \
     --username cn=user1,cn=api-users --password secret --table json \
     --metric throughput --instanceType proxy --statistic average \
     --pivot op-type --pivot application-name --dimension op-type:search,modify \
     --rateScaling second --maxIntervals 100 --startTime 2012-09-01T17:41Z \
     --endTime 2012-09-30T17:41Z

List the set of metric definitions collected by the Metrics Engine

The Metrics Engine collects metric information from monitored servers. This command can be used to view this information

query-metric list-metrics --includeDimensions

List server instances for which data has been collected by the Metrics Engine

The Metrics Engine is configured to collect metric samples from a set of monitored servers. This command can be used to view the set of server instances from which the Metrics Engine has ever collected metric samples. This may include servers currenty being monitored as well as server instances that are no longer be actively monitored

query-metric list-instances

List the set of dimensions and their current values

The Metrics Engine collects dimension values from monitored servers. Some dimensions like op-type have static values that do not change over time. However most dimensions have values that are collected from monitored servers and vary by deployment. This command can be used to view all dimensions and their current values

query-metric list-dimensions

Arguments

-V
--version

-H
--help

--help-debug

-h {host}
--hostname {host}

-p {port}
--httpPort {port}

-Z
--useSSL

-X
--trustAll

-D {userName}
--username {userName}

-w {password}
--password {password}

-j {passwordFile}
--passwordFile {passwordFile}

--propertiesFilePath {propertiesFilePath}

-n
--no-prompt

--script-friendly

--help-subcommands