Skip to navigation Skip to main content Skip to footer
Docs
    Start for free
    1. Docs
    2. Octopus REST API
    3. Octopus.Server.exe command line
    4. Metrics

    Metrics

    Edit on GitHub

    The metrics command was removed in Octopus 2020.5.0.

    Page updated on Sunday, January 1, 2023

    Use Octopus docs with AI
    • Open this page as markdown
    • Open all docs as markdown
    Previous article Set Master Key
    Next article New certificate

    Navigation

    • Introduction
    • Getting started
    • Octopus Cloud
    • Installation
    • Best Practices
    • Octopus AI
    • Kubernetes
    • Argo CD
    • Infrastructure
    • Platform Hub
    • Packaging applications
    • Projects
    • Tenants
    • Releases
    • Deployments
    • Runbooks
    • Feature Flags
    • Tasks
    • Approvals
    • Insights
    • Octopus REST API
      • Overview
      • Getting started with the Octopus REST API
      • How to Create an API Key
      • Octopus.Client
        • Octopus.Client
        • Getting started
        • Working with Resources
        • Working directly with the Client
        • Working with Spaces
        • Using in an Octopus Step
      • Using OpenID Connect with the Octopus API
        • Using OpenID Connect with the Octopus API
        • Using OpenID Connect with Octopus and GitHub Actions
        • Using OpenID Connect in Octopus with other issuers
      • API examples
        • API examples
        • Accounts
          • Accounts
          • Create an AWS account
          • Create an Azure service principal
          • Create a Google Cloud account
        • Artifacts
          • Artifacts
          • Upload Artifact to Existing Deployment
          • Download Deployment Artifact
          • Download Runbook Artifact
        • Certificates
          • Certificates
          • Create a certificate
          • Replace existing certificate
        • Channels
          • Channels
          • Create a channel
        • Deployment process
          • Deployment process
          • Add an environment to step
          • Add a run a script step
          • Get all steps that use a package
          • Get all steps using role
        • Deployment targets
          • Deployment targets
          • Add an Azure Web App
          • Add a target role
          • Add Tenants to targets
          • Change target's machine policy
          • Check Tentacles for available upgrades
          • Delete targets by name
          • Delete targets by role
          • Deactivate machines
          • Find target usage
          • Find unused targets
          • Register Listening Tentacle
          • Register Polling Tentacle
          • Register SSH target
          • Upgrade targets
        • Deployments
          • Deployments
          • Cancel queued deployments
          • Create and deploy a release
          • Deploy existing release with prompted variables
          • Deploy existing release
          • List deployments to environment
        • Environments
          • Environments
          • Adding Environments
        • Events
          • Events
          • Find events by date
        • Feeds
          • Feeds
          • Change feed
          • Create a feed
          • Delete a feed
          • Download package from built-in feed
          • Push package to built-in feed
          • Retrieve all feeds
          • Synchronize packages
        • Lifecycles
          • Lifecycles
          • Create a lifecycle
        • Project Groups
          • Project Groups
          • Create a project group
        • Projects
          • Projects
          • Coordinating multiple projects
          • Create a project
          • Delete a project
          • Delete projects with no process
          • Disable project triggers
          • Deactivate projects
          • Export projects
          • Find unused projects
          • Import projects
        • Releases
          • Releases
          • Create a release with specific version
          • Delete project releases
          • Promote a release not in the destination
          • Update release variable snapshot
        • Reports
          • Reports
          • Deployments Per Deployment Target Role Report
          • Environment permissions report
          • Project permissions report
          • Project Release Deployment Targets Report
        • Runbooks
          • Runbooks
          • Add a script step to runbook
          • Create and publish a new runbook snapshot
          • Create a runbook
          • Create a new scheduled runbook trigger
          • Publish a runbook snapshot
          • Run a runbook with prompted variables
          • Run a published runbook
        • Spaces
          • Spaces
          • Add a Space with environments
          • Delete a Space
        • Step Templates
          • Step Templates
          • Export step templates
        • Tag sets
          • Tag sets
          • Create a tag set
        • Tasks
          • Tasks
          • Reprioritize Tasks
          • Run a health check
        • Tenants
          • Tenants
          • Create a tenant
          • Deactivate tenants
          • Update tenant variables
        • Users and Teams
          • Users and Teams
          • Add Microsoft Entra ID login to users
          • Add domain teams
          • Add an environment to a team
          • Change users domain
          • Create an API Key
          • Find teams with role
          • List users with editing roles
          • List users with role
          • List users
          • Remove a project from team
          • Swap AD group with LDAP group
          • Change users AD domain to LDAP
        • Variables
          • Variables
          • Add variable set to a project
          • Add or update project variable
          • Clear sensitive variables
          • Find projects using variable set
          • Find variable usage
          • Find variable value usage
          • Find variable set variables usage
          • Update variable set variable value
        • Bulk Operations
          • Bulk Operations
          • Bulk add a project to a list of tenants
          • Rerun all canceled deployments and runbook runs after node shutdown.
      • Octopus.Server.exe command line
        • Octopus.Server.exe command line
        • Admin
        • Check services
        • Configure
        • Create instances
        • Database
        • Delete instances
        • Export certificates
        • Import certificates
        • License
        • List instances
        • Lost Master Key
        • Rotate Master Key
        • Set Master Key
        • Metrics
        • New certificate
        • Node
        • Built-in Worker
        • Path
        • External Worker
        • Proxy
        • Regenerate certificates
        • Run
        • Service
        • Show configuration
        • Show Master Key
        • Show thumbprint
        • SSL certificate
        • Version
        • Watchdog
      • Tentacle.exe command line
        • Tentacle.exe command line
        • Agent
        • Check services
        • Configure
        • Create instance
        • Delete instance
        • Deregister from
        • Deregister Worker
        • Extract
        • Import certificate
        • List instances
        • New certificate
        • Poll server
        • Polling proxy
        • Proxy
        • Register with
        • Register Worker
        • Server comms
        • Service
        • Show configuration
        • Show thumbprint
        • Update trust
        • version
        • watchdog
      • Calamari
      • Octopus.Migrator.exe command line
        • Octopus.Migrator.exe command line
        • Migrator export
        • Migrator import
        • migrate
        • Partial export
        • Version
      • Migration API
      • CLI
        • CLI
        • octopus
        • octopus account
        • octopus account aws
        • octopus account aws create
        • octopus account aws list
        • octopus account azure
        • octopus account azure create
        • octopus account azure list
        • octopus account azure-oidc
        • octopus account azure-oidc create
        • octopus account azure-oidc list
        • octopus account create
        • octopus account delete
        • octopus account gcp
        • octopus account gcp create
        • octopus account gcp list
        • octopus account generic-oidc
        • octopus account generic-oidc create
        • octopus account generic-oidc list
        • octopus account list
        • octopus account ssh
        • octopus account ssh create
        • octopus account ssh list
        • octopus account token
        • octopus account token create
        • octopus account token list
        • octopus account username
        • octopus account username create
        • octopus account username list
        • octopus api
        • octopus build-information
        • octopus build-information bulk-delete
        • octopus build-information delete
        • octopus build-information list
        • octopus build-information upload
        • octopus build-information view
        • octopus channel
        • octopus channel create
        • octopus config
        • octopus config get
        • octopus config list
        • octopus config set
        • octopus deployment-target
        • octopus deployment-target azure-web-app
        • octopus deployment-target azure-web-app create
        • octopus deployment-target azure-web-app list
        • octopus deployment-target azure-web-app view
        • octopus deployment-target cloud-region
        • octopus deployment-target cloud-region create
        • octopus deployment-target cloud-region list
        • octopus deployment-target cloud-region view
        • octopus deployment-target delete
        • octopus deployment-target kubernetes
        • octopus deployment-target kubernetes create
        • octopus deployment-target kubernetes list
        • octopus deployment-target kubernetes view
        • octopus deployment-target list
        • octopus deployment-target listening-tentacle
        • octopus deployment-target listening-tentacle create
        • octopus deployment-target listening-tentacle list
        • octopus deployment-target listening-tentacle view
        • octopus deployment-target polling-tentacle
        • octopus deployment-target polling-tentacle list
        • octopus deployment-target polling-tentacle view
        • octopus deployment-target ssh
        • octopus deployment-target ssh create
        • octopus deployment-target ssh list
        • octopus deployment-target ssh view
        • octopus deployment-target view
        • octopus environment
        • octopus environment create
        • octopus environment delete
        • octopus environment list
        • octopus environment tag
        • octopus ephemeral-environment
        • octopus ephemeral-environment create
        • octopus ephemeral-environment deprovision-environment
        • octopus ephemeral-environment deprovision-project
        • octopus login
        • octopus logout
        • octopus package
        • octopus package delete
        • octopus package list
        • octopus package nuget
        • octopus package nuget create
        • octopus package upload
        • octopus package versions
        • octopus package zip
        • octopus package zip create
        • octopus project
        • octopus project branch
        • octopus project branch create
        • octopus project branch list
        • octopus project clone
        • octopus project connect
        • octopus project convert
        • octopus project create
        • octopus project delete
        • octopus project disable
        • octopus project disconnect
        • octopus project enable
        • octopus project list
        • octopus project tag
        • octopus project variables
        • octopus project variables create
        • octopus project variables delete
        • octopus project variables exclude
        • octopus project variables include
        • octopus project variables list
        • octopus project variables update
        • octopus project variables view
        • octopus project view
        • octopus project-group
        • octopus project-group create
        • octopus project-group delete
        • octopus project-group list
        • octopus project-group view
        • octopus release
        • octopus release create
        • octopus release delete
        • octopus release deploy
        • octopus release list
        • octopus release progression
        • octopus release progression allow
        • octopus release progression prevent
        • octopus runbook
        • octopus runbook delete
        • octopus runbook list
        • octopus runbook run
        • octopus runbook snapshot
        • octopus runbook snapshot create
        • octopus runbook snapshot list
        • octopus runbook snapshot publish
        • octopus space
        • octopus space create
        • octopus space delete
        • octopus space list
        • octopus space view
        • octopus task
        • octopus task wait
        • octopus tenant
        • octopus tenant clone
        • octopus tenant connect
        • octopus tenant create
        • octopus tenant delete
        • octopus tenant disable
        • octopus tenant disconnect
        • octopus tenant enable
        • octopus tenant list
        • octopus tenant tag
        • octopus tenant variables
        • octopus tenant variables list
        • octopus tenant variables update
        • octopus tenant view
        • octopus user
        • octopus user delete
        • octopus user list
        • octopus worker
        • octopus worker delete
        • octopus worker list
        • octopus worker listening-tentacle
        • octopus worker listening-tentacle create
        • octopus worker listening-tentacle list
        • octopus worker listening-tentacle view
        • octopus worker polling-tentacle
        • octopus worker polling-tentacle list
        • octopus worker polling-tentacle view
        • octopus worker ssh
        • octopus worker ssh create
        • octopus worker ssh list
        • octopus worker ssh view
        • octopus worker view
        • octopus worker-pool
        • octopus worker-pool delete
        • octopus worker-pool dynamic
        • octopus worker-pool dynamic create
        • octopus worker-pool dynamic view
        • octopus worker-pool list
        • octopus worker-pool static
        • octopus worker-pool static create
        • octopus worker-pool static view
        • octopus worker-pool view
      • Octo Command Line (CLI) (Deprecated)
        • Octo Command Line (CLI) (Deprecated)
        • Octopus CLI Global Tool
        • JSON formatted output
        • Allow release progression
        • Build information
        • Clean environments
        • Clean Worker pool
        • Complete
        • Create auto deployment override
        • Create channel
        • Create environment
        • Create project
        • Create release
        • Create Worker pool
        • Delete auto deploy override
        • Delete package
        • Delete project
        • Delete releases
        • Deploy release
        • Disable project
        • Dump deployments
        • Export
        • Import
        • Install autocomplete
        • List deployments
        • List environments
        • List latest deployments
        • List machines
        • List projects
        • List releases
        • List tenants
        • List Worker pools
        • List Workers
        • Pack
        • Prevent release progression
        • Promote release
        • Push metadata
        • Push
        • Run a runbook
        • Version
    • Administration
    • Security
    • Support
    • Credits
    • GitHub Organizations
    • Deprecations
    • Search

    Was this page helpful?

    Thanks for your feedback!

    Platform

    • Continuous Delivery platform
    • Platform Hub
    • AI tools
    • Tenanted deployments

    Resources

    • Documentation
    • Download Octopus
    • Publications
    • Blog

    Our company

    • About us
    • Careers
    • Roadmap
    • Investor relations
    • Brand guidelines

    Help and support

    • Contact Sales
    • Support
    • Upgrade
    • Security and legal
    • Community Slack

    Our awards

    • Award badge for "Best Meets Requirements" from G2, Summer 2026.
    • Gartner badge - Users love us
    • Badge displaying "High Performer Enterprise" for Summer 2026 with G2 logo.

    Sign up to our newsletter

    Marketplaces

    • Azure marketplace logo Azure marketplace
    • AWS logo with bold white letters "aws" and an orange curved arrow below on a black background. AWS marketplace
    • Octopus blue logo © 2026 Octopus Deploy
    • Privacy Policy
    • GDPR
    • Terms
    • Status
    • SOC 2 Type II compliance
    • Argo logo
    • X logo
    • LinkedIn logo
    • GitHub logo
    • YouTube logo