Project: KubeDB by AppsCode (App Definition and Development / Database)
File: kubectl-dba_monitor_dashboard.md

title: Kubectl-Dba Monitor Dashboard menu: docs_{{ .version }}: identifier: kubectl-dba-monitor-dashboard name: Kubectl-Dba Monitor Dashboard parent: reference-cli menuname: docs{{ .version }} sectionmenuid: reference Check availability of a grafana dashboard Check availability of metrics in prometheus server used in a grafana dashboard. ``` kubectl-dba monitor dashboard ``` ``` kubectl dba monitor dashboard [DATABASE] [DATABASE_NAME] -n [NAMESPACE] \ [DASHBOARDNAME] --file=[FILECONTAININGDASHBOARDJSON] --file=[FILECONTAININGREMOTE_URL] \ <- these are ORed --prom-svc-name=[PROMSVCNAME] --prom-svc-namespace=[PROMSVCNS] --prom-svc-port=[PROMSVCPORT] kubectl-dba monitor dashboard postgres pg15 -n demo \ --file=/home/arnob/yamls/summary.json \ --prom-svc-name=prometheus-kube-prometheus-prometheus --prom-svc-namespace=monitoring --prom-svc-port=9090 Valid dashboards include: elasticsearch kafka mariadb mongodb mysql perconaxtradb postgres proxysql redis If --file is given, that is the local file. absolute or relative path both accepted. If --url is given, that is the remote file. You have to specify the full raw url. If just the dashboard name is given, then that will be searched in our dashboard repo. To be exact if mongodb-summary-dashboard specified only, The cli will look for the json in https://raw.githubusercontent.com/appscode/grafana-dashboards/master/mongodb/mongodb-summary-dashboard.json ``` ``` -b, --branch string branch name of the github repo (default "master") -f, --file string absolute or relative path of the file containing dashboard -h, --help help for dashboard -u, --url string url of the raw file containing dashboard. For example: https://raw.githubusercontent.com/appscode/grafana-dashboards/master/mongodb/mongodb-summary-dashboard.json ``` ``` --as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace. --as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups. --as-uid string UID to impersonate for the operation. --cache-dir string Default cache directory (default "/home/runner/.kube/cache") --certificate-authority string Path to a cert file for the certificate authority --client-certificate string Path to a client certificate file for TLS --client-key string Path to a client key file for TLS --cluster string The name of the kubeconfig cluster to use --context string The name of the kubeconfig context to use --default-seccomp-profile-type string Default seccomp profile --disable-compression If true, opt-out of response compression for all requests to the server --insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure --kubeconfig string Path to the kubeconfig file to use for CLI requests. --match-server-version Require server version to match client version -n, --namespace string If present, the namespace scope for this CLI request --password string Password for basic authentication to the API server --prom-svc-name string name of the prometheus service --prom-svc-namespace string namespace of the prometheus service --prom-svc-port int port of the prometheus service (default 9090) --request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0") -s, --server string The address and port of the Kubernetes API server --tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used --token string Bearer token for authentication to the API server --user string The name of the kubeconfig user to use --username string Username for basic authentication to the API server ``` - Monitoring related commands for a database