Versions Compared

Version Old Version 1 New Version Current
Changes made by

Jenni Wallin

Jenni Wallin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The systeminsight command has four subcommands: profile, metrics, retentionPolicy and test. 

profile

To use System Insight, you must determine the profile that you want to apply, which you configure using the systeminsight profile command. The subcommands described below enable you to manage a profile.

Note
titleNote!

The System Insight service must be running before you create, modify or remove a profile. You start the service using the command mzsh service start. For information on how to configure System Insight services, see 2.2.1 Configure System Insight Services.

create

Use systeminsight profile create to create a System Insight profile. To create a profile, you must specify the folder in which you want to save the profile, the profile name, a description of the profile, and the retention policy for the profile.

...

Note
titleNote!

After you have created a profile, the qualified profile name that is thereafter required when you use the systeminsight command to manage the profile consists of the folder name + the unique profile name: <folder name>.<profile name>, e g Default.siprofile1.

remove

Use systeminsight profile remove to delete a specific System Insight profile.

...

OptionDesription
-profile <qualified name of profile>Provide the qualified name of the profile that you want to delete.
[-f, --force]Use this option to forcibly remove a profile.

addFilter

Use systeminsight profile addFilter to add a filter to the filter list. To add a filter, you must specify the qualified profile name of the profile to which you want to add the filter, and the regular expression that you want to include in the filter. You can also add the tag value regular expressions that you want to include.

...

Info
titleExamples of how to add a filter

A simple rule:

Code Block
languagetext
themeEclipse
systeminsight profile addFilter -profile Default.siprofile1 -e "host\.comp3\.comp3"

A rule which requires forced addition:

Code Block
languagetext
themeEclipse
systeminsight profile addFilter -f -profile Default.siprofile1 -e ".*pico\.comp1\.comp1"

Example of a filter including tag value reglar expressions:

Code Block
languagetext
themeEclipse
systeminsight profile addFilter -profile Default.siprofile1 -e "pico\..*" -t "host_name=myhost[0-9]*"


removeFilter

Use systeminsight profile removeFilter to delete a filter from the filter list in a profile. You must specify the profile that contains the filter, and the filter that you want to delete.

...

OptionDescription
-profile <qualified name of profile>Specify the qualified name of the profile that contains the filter that you want to delete.
-id <filter id>Specify the filter that you want to delete.

disable

Use systeminsight profile disable to set a profile to disabled status. You must provide the qualified name of the profile that you want to disable.

enable

Use systeminsight profile enable to set a profile to enabled status. You must provide the qualified name of the profile that you want to enable. If a profile is not set to enabled, you cannot use the filters it contains to produce the required statistics.

list

Use systeminsight profile list to list all the profiles, or to list all the filters that have been added for a specific profile. You are also provided with the retention policy that applies to each profile and whether the profile is enabled or disabled.

...

OptionDescription
-profile <qualified name of profile>Specify the qualified name of the profile that contains the filters.
[-j, --json]Use this option if you want to print the filters in json output format.

metrics

Use systeminsight metrics to list all of the metrics available on the running system, to which you can apply a filter in order to produce statistics using System Insight. Each metric is listed with the available tags and tag values.

...

Info
titleExample - MIM metrics based on a running workflow

If you have a workflow with a Workflow Bridge processing agent, the metrics available may look as follows:

MetricsTagsTag Values
mim.realtime.processing.workflow_bridge agent_category<"processing">
agent_name<"Workflow_Bridge_1">
host_name<"host name">
pico_instance<"ec1">
workflow_folder<"Default">
workflow_instance<"wf">
workflow_name<"fwd">
workflow_type<"realtime">


retentionPolicy

You can also list the retention policies.

Note
titleNote!

The System Insight service must be running before the systeminsight retentionPolicy command is available. You start the service using the command mzsh service start. For information on how to configure System Insight services, see 2.2.1 Configure System Insight Services.

list

Use systeminsight retentionPolicy list to list all the retention policies in place.

...

Info
titleExample of retention policy list


Code Block
languagetext
themeEclipse
systeminsight  retentionPolicy  list
Name           Duration
one_month      720h
one_day        24h
one_week       168h (Default)
three_months   2160h
one_year       8760h
ten_years      87600h
three_hours    3h


test

Use systeminsight test to get a list of the filters for a metric. Specifying a tag refines the metric, and is optional.

...

Info
titleExamples of how to test which filters match a metric

If you have the following four filters in place:

FilteridRegular expressionTag Regular Expression
1custom\.system
2custom\.systemtag1=a.*
3custom\.systemtag1=a.*, tag2=b.*
4custom\.systemtag1=a.*, tag2=b.*, tag3=c.*

Example 1

If you test which filters match the metric name "custom.system" by entering the following:

Code Block
languagetext
themeEclipse
systeminsight test -n custom.system

The output is as follows:


Code Block
languagetext
themeEclipse
Profile: Default.siprofile1
FilterId      RegularExpression    Tag RegularExpressions         
1             custom\.system       Map()       
2             custom\.system       Map(tag1=a.*)       
3             custom\.system       Map(tag1=a.*, tag2=b.*)       
4             custom\.system       Map(tag1=a.*, tag2=b.*, tag3=c.*)


Example 2

If you test which filters match the metric name "custom.system" and the tag name and tag value pair tag1=aaa by entering the following:

Code Block
languagetext
themeEclipse
systeminsight test -n custom.system -t tag1=aaa

The output is as follows:

Code Block
languagetext
themeEclipse
Profile: Default.siprofile1
FilterId      RegularExpression    Tag RegularExpressions    
1             custom\.system       Map()       
2             custom\.system       Map(tag1=a.*)


Example 3

If you test which filters match the metric name "custom.system" and the tag name and tag value pairs tag1=aaa and tag2=bbb, by entering the following:

Code Block
languagetext
themeEclipse
systeminsight test -n custom.system-t tag1=aaa tag2=bbb

The output is as follows:

Code Block
languagetext
themeEclipse
Profile: Default.siprofile1
FilterId      RegularExpression    Tag RegularExpressions   
1             custom\.system       Map()       
2             custom\.system       Map(tag1=a.*)       
3             custom\.system       Map(tag1=a.*, tag2=b.*)


Example 4

If you test which filters match the metric name "custom.system" and the tag name and tag value pairs tag1=aaa, tag2=bbb and tag3=ccc, by entering the following:

Code Block
languagetext
themeEclipse
systeminsight test -n custom.system-t tag1=aaa tag2=bbb tag3=ccc

The output is as follows:

Code Block
languagetext
themeEclipse
Profile: Default.siprofile1
FilterId     RegularExpression    Tag RegularExpressions   
1            custom\.system       Map()       
2            custom\.system       Map(tag1=a.*)       
3            custom\.system       Map(tag1=a.*, tag2=b.*)       
4            custom\.system       Map(tag1=a.*, tag2=b.*, tag3=c.*)


Return Codes

Listed below are the different return codes for the systeminsight command:

...