CLICommand referenceanalytics

analytics

Commands, arguments, and options for openship analytics.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship analytics

Read project traffic, deployments and runtime resource measurements

openship analytics [options] [command]
SubcommandPurpose
dashboardShow totals for accessible projects and deployments
summary [options] <project>Show request, visitor and bandwidth totals
traffic [options] <project>Show traffic totals and time buckets
periods [options] <project>Read traffic time buckets
geo [options] <project>Read traffic geography and request paths
deployments <project>Show deployment reliability and build duration
usage <project>Read current project runtime usage
container <project>Read runtime container details
resources <project>Read service measurements and destination capacity
history [options] <project>Read historical CPU, memory and network usage
paths <project> <state>Enable or disable collection of request paths
watch [options] <project>Stream live project resource measurements
serverInspect traffic for a domain handled by a particular server

openship analytics container

Read runtime container details

openship analytics container [options] <project>
ArgumentMeaning
projectProject ID

openship analytics dashboard

Show totals for accessible projects and deployments

openship analytics dashboard [options]

openship analytics deployments

Show deployment reliability and build duration

openship analytics deployments [options] <project>
ArgumentMeaning
projectProject ID

openship analytics geo

Read traffic geography and request paths

openship analytics geo [options] <project>
ArgumentMeaning
projectProject ID
OptionMeaning
--from <timestamp>ISO start time
--to <timestamp>ISO end time
--domain <domain>Route filter

openship analytics history

Read historical CPU, memory and network usage

openship analytics history [options] <project>
ArgumentMeaning
projectProject ID
OptionMeaning
--from <timestamp>ISO start time
--to <timestamp>ISO end time
--service <key>Service key from history results

openship analytics paths

Enable or disable collection of request paths

openship analytics paths [options] <project> <state>
ArgumentMeaning
projectProject ID
stateon | off

openship analytics periods

Read traffic time buckets

openship analytics periods [options] <project>
ArgumentMeaning
projectProject ID
OptionMeaning
--from <timestamp>ISO start time
--to <timestamp>ISO end time
--domain <domain>Route filter

openship analytics resources

Read service measurements and destination capacity

openship analytics resources [options] <project>
ArgumentMeaning
projectProject ID

openship analytics server

Inspect traffic for a domain handled by a particular server

openship analytics server [options] [command]
SubcommandPurpose
buckets [options] <server> <domain>Read stored domain traffic buckets
geo [options] <server> <domain>Read domain traffic geography
live <server> <domain>Read current domain traffic counters

openship analytics server buckets

Read stored domain traffic buckets

openship analytics server buckets [options] <server> <domain>
ArgumentMeaning
serverServer ID
domainHostname
OptionMeaning
--from <timestamp>ISO start time
--to <timestamp>ISO end time

openship analytics server geo

Read domain traffic geography

openship analytics server geo [options] <server> <domain>
ArgumentMeaning
serverServer ID
domainHostname
OptionMeaning
--day <date>UTC day as YYYYMMDD

openship analytics server live

Read current domain traffic counters

openship analytics server live [options] <server> <domain>
ArgumentMeaning
serverServer ID
domainHostname

openship analytics summary

Show request, visitor and bandwidth totals

openship analytics summary [options] <project>
ArgumentMeaning
projectProject ID
OptionMeaning
--domain <domain>Route filter

openship analytics traffic

Show traffic totals and time buckets

openship analytics traffic [options] <project>
ArgumentMeaning
projectProject ID
OptionMeaning
--from <timestamp>ISO start time
--to <timestamp>ISO end time
--domain <domain>Route filter

openship analytics usage

Read current project runtime usage

openship analytics usage [options] <project>
ArgumentMeaning
projectProject ID

openship analytics watch

Stream live project resource measurements

openship analytics watch [options] <project>
ArgumentMeaning
projectProject ID
OptionMeaning
--timeout <ms>Stop after this deadline

On this page