Skip to content

dx_ctl_analytics

Marcin Przepiorowski edited this page Oct 6, 2017 · 7 revisions

SYNOPSIS

dx_ctl_analytics      [ -engine|d <delphix identifier> | -all ] [ -configfile file ]
                      -type <cpu|disk|nfs|iscsi|network|nfs-by-client|nfs-all|all|standard|comma separated names> 
                      -action start|stop|restart|display|create|delete
                      [-format csv|json]
                      [-debug]

DESCRIPTION

Control analytics collector inside Delphix Engine

ARGUMENTS

Delphix Engine selection - if not specified a default host(s) from dxtools.conf will be used.

  • -engine|d Specify Delphix Engine name from dxtools.conf file
  • -all Run script for all Delphix Engines from config file
  • -configfile file Location of the configuration file. A config file search order is as follow:
  • configfile parameter
  • DXTOOLKIT_CONF variable
  • dxtools.conf from dxtoolkit location
    • -type|t Type: cpu|disk|nfs|iscsi|network|nfs-by-client|nfs-all|all|standard|comma separated names

      ex.

      • -type all - for all analytics
      • -type standard - for cpu,disk,network and nfs analytics
      • -t cpu,disk - for cpu and disk
    • -action start|stop|restart|display|create|delete

      Choose action on selected analytic type

      Custom analytics can be created or deleted using create or delete operation and following types: nfs-by-client, nfs-all

OPTIONS

  • -format csv|json
    Display output in csv or json format If not specified csv formatting is used.
  • -nohead Turn off header output
  • -help
    Print this screen
  • -debug
    Turn on debugging

EXAMPLES

Restart all collectors

dx_ctl_analytics -d Landshark5 -action restart -type all
Connected to Delphix Engine Landshark5 (IP 172.16.180.131)
Analytic default.cpu has been stopped 
Analytic default.cpu has been started 
Analytic default.disk has been stopped 
Analytic default.disk has been started 
Analytic default.iscsi has been stopped 
Analytic default.iscsi has been started 
Analytic iscsi-by-client has been stopped 
Analytic iscsi-by-client has been started 
Analytic default.network has been stopped 
Analytic default.network has been started 
Analytic default.nfs has been stopped 
Analytic default.nfs has been started 
Analytic nfs-all has been stopped 
Analytic nfs-all has been started 
Analytic nfs-by-client has been stopped 
Analytic nfs-by-client has been started 
Analytic default.tcp has been stopped 
Analytic default.tcp has been started

Create new collector - nfs-all

dx_ctl_analytics -d Landshark5 -action create -type nfs-all 
Connected to Delphix Engine Landshark5 (IP 172.16.180.131) 
New analytic nfs-all has been created

Display collectors specified as a comma separated list

dx_ctl_analytics -d Landshark5 -action display -type cpu,disk,nfs 
Connected to Delphix Engine Landshark5 (IP 172.16.180.131)
Engine         Analytic   State    Axes 
-------------- ---------- -------- -------------------------------------------------------
Landshark5     cpu        RUNNING  idle,user,kernel
Landshark5     disk       RUNNING  latency,avgLatency,throughput,count,op
Landshark5     nfs        RUNNING  latency,throughput,count,op

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

  • Around line 265:

    You forgot a '=back' before '=head1'

Delphix

Clone this wiki locally