metrics

Documentation

Overview

Copyright 2020 MongoDB Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func Builder() *cobra.Command
• func DatabasesBuilder() *cobra.Command
• func DatabasesDescribeBuilder() *cobra.Command
• func DatabasesListBuilder() *cobra.Command
• func DisksBuilder() *cobra.Command
• func DisksDescribeBuilder() *cobra.Command
• func DisksListBuilder() *cobra.Command
• func ProcessBuilder() *cobra.Command
• type DatabasesDescribeOpts
  • func (opts *DatabasesDescribeOpts) Run() error
• type DatabasesListsOpts
  • func (opts *DatabasesListsOpts) Run() error
• type DisksDescribeOpts
  • func (opts *DisksDescribeOpts) Run() error
• type DisksListsOpts
  • func (opts *DisksListsOpts) Run() error
• type ProcessOpts
  • func (opts *ProcessOpts) Run() error

Constants

const (
	ProcessMeasurements = "Get measurements for a given host."
	Disks               = "List available disks or disks measurements for a given host."
	ListDisks           = "List available disks for a given host."
	DescribeDisks       = "Describe disks measurements for a given host partition."
	Databases           = "List available databases or databases measurements for a given host."

	ListDatabases = "List available databases for a given host."
	Metrics       = "Get measurements on the state of the MongoDB process."
)

Functions

func Builder

func Builder() *cobra.Command

func DatabasesBuilder

func DatabasesBuilder() *cobra.Command

func DatabasesDescribeBuilder

func DatabasesDescribeBuilder() *cobra.Command

mcli om metric(s) disk(s) describe <hostId:port> <name> --granularity g --period p --start start --end end [--type type] [--projectId projectId]

func DatabasesListBuilder

func DatabasesListBuilder() *cobra.Command

mongocli om metric(s) process(es) disks lists <HOST_ID>

func DisksBuilder

func DisksBuilder() *cobra.Command

func DisksDescribeBuilder

func DisksDescribeBuilder() *cobra.Command

mcli om metric(s) disk(s) describe <hostId:port> <name> --granularity g --period p --start start --end end [--type type] [--projectId projectId]

func DisksListBuilder

func DisksListBuilder() *cobra.Command

mongocli om metric(s) process(es) disks lists <ID>

func ProcessBuilder

func ProcessBuilder() *cobra.Command

mongocli om|cm metric(s) process(es) <ID> [--granularity granularity] [--period period] [--start start] [--end end] [--type type][--projectId projectId]

Types

type DatabasesDescribeOpts

type DatabasesDescribeOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	cli.MetricsOpts
	// contains filtered or unexported fields
}

func (*DatabasesDescribeOpts) Run

func (opts *DatabasesDescribeOpts) Run() error

type DatabasesListsOpts

type DatabasesListsOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	cli.ListOpts
	// contains filtered or unexported fields
}

func (*DatabasesListsOpts) Run

func (opts *DatabasesListsOpts) Run() error

type DisksDescribeOpts

type DisksDescribeOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	cli.MetricsOpts
	// contains filtered or unexported fields
}

func (*DisksDescribeOpts) Run

func (opts *DisksDescribeOpts) Run() error

type DisksListsOpts

type DisksListsOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	cli.ListOpts
	// contains filtered or unexported fields
}

func (*DisksListsOpts) Run

func (opts *DisksListsOpts) Run() error

type ProcessOpts

type ProcessOpts struct {
	cli.GlobalOpts
	cli.OutputOpts
	cli.MetricsOpts
	// contains filtered or unexported fields
}

func (*ProcessOpts) Run

func (opts *ProcessOpts) Run() error