github.com/minio/mc@v0.0.0-20240503112107-b471de8d1882/cmd/admin-top-api.go (about)

     1  // Copyright (c) 2015-2022 MinIO, Inc.
     2  //
     3  // This file is part of MinIO Object Storage stack
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package cmd
    19  
    20  import (
    21  	"github.com/minio/cli"
    22  )
    23  
    24  var adminTopAPIFlags = []cli.Flag{
    25  	cli.StringSliceFlag{
    26  		Name:  "name",
    27  		Usage: "summarize current calls for matching API name",
    28  	},
    29  	cli.StringSliceFlag{
    30  		Name:  "path",
    31  		Usage: "summarize current API calls only on matching path",
    32  	},
    33  	cli.StringSliceFlag{
    34  		Name:  "node",
    35  		Usage: "summarize current API calls only on matching servers",
    36  	},
    37  	cli.BoolFlag{
    38  		Name:  "errors, e",
    39  		Usage: "summarize current API calls throwing only errors",
    40  	},
    41  }
    42  
    43  var adminTopAPICmd = cli.Command{
    44  	Name:            "api",
    45  	Usage:           "summarize API events on MinIO server in real-time",
    46  	Action:          mainAdminTopAPI,
    47  	OnUsageError:    onUsageError,
    48  	Before:          setGlobalsFromContext,
    49  	Flags:           append(adminTopAPIFlags, globalFlags...),
    50  	Hidden:          true,
    51  	HideHelpCommand: true,
    52  	CustomHelpTemplate: `Please use 'mc support top api' 
    53  `,
    54  }
    55  
    56  func mainAdminTopAPI(_ *cli.Context) error {
    57  	deprecatedError("mc support top api")
    58  	return nil
    59  }