Types

Overview

Types allow managed entities to be configured logically by a shared property, rather than by explicitly adding a list of samplers to every managed entity with that property.

A type consists of a list of samplers and, optionally, environments for user variables. The list of samplers is added to every managed entity which references the type. Future changes to the sampler list can then be confined to the type definition, rather than editing the definitions for a set of managed entities.

For example, you could configure a set of samplers for monitoring a Linux-based system as a "Linux" type definition. This type can then be referenced by managed entities running on Linux machines (or better, referenced by a managed entity group which contains these entities). Additional Linux machines added later can then reference this type, or extra samplers can be added to the type to extend monitoring of all Linux systems.

Another example might be to monitor servers for a particular trading system, e.g. Fidessa. Samplers to monitor a Fidessa system may be listed in a type "Fidessa", with system-specific file locations specified using a variable value. Managed entities could then reference the type, with an environment that sets the specific paths used on that system.

Entities can be configured with multiple types by referencing the required types by name. To avoid ambiguity, types must be configured with a unique name among all types in the top-level section. A managed entity which references the same type multiple times will only load the samplers for that type once; otherwise the managed entity will run several samplers with the same configuration and perform unnecessary work. Similarly, a warning is generated if the same sampler is referenced multiple times within a type.

Operation

How to create a new type

Steps to create a new type using the Gateway Setup Editor are shown below:

  1. Select the Types top-level section. Double-click to create this section if it does not exist..
  2. Select New type to create a new type definition.
  3. Give the new type a unique name. This name is used to reference the type in other parts of the gateway setup (primarily Managed Entities and Managed Entity Groups).

Note: Names are case sensitive.

  1. Configure the sampler list for this type. Samplers are referenced by name from the Samplers top-level section. Configuring the same sampler multiple times will lead to a validation warning.
  2. (Optional) Specify environment for the type, which is used to resolve variables in sampler configurations. See User Variables and Environments.
  3. (Optional) In the Advanced tab, configure variables. A variable configured in the type overrides a variable configured in the environment referenced at step 5 (if any).

How to create a new type group

Types can be grouped for ease of management in Gateway Setup Editor. To create a new type group, follow these steps;

  1. Right-click on the Types top-level section and select the New typeGroup.
  2. Specify the name for the new type. Names of groups are not read by gateway and so can be used for descriptive purposes.
  3. Add types to the type group. New types can be created in the group by selecting the New type button. Types can also be added and removed from the group using drag-and-drop in the Navigation tree.
  4. Type groups can be added and removed from other type groups using drag-and-drop in the Navigation tree. New type-groups can also be added to a group by right-clicking on the group in the tree and selecting New typeGroup.

Configuration

This section describes all configuration settings available in the Types top-level section.

types

The types top-level section contains the definition of all types in the gateway setup. These types are referenced in managed entities, and are intended to simplify gateway setup configurations by enabling reuse of common lists of samplers.

Mandatory: No

types > type

A type definition specifies a single type.

This consists of a list of samplers, an optional environment for variable resolution in sampler configuration, and optional variable declarations for overriding values in the environment.

types > type > name

Specifies the name for the type.

This name must be unique among all other configured types, to avoid ambiguity when the type is referenced (for example in a managed entity).

The type name is case-sensitive.

Mandatory: Yes

types > type > environment

Optional named reference to an environment.

See User Variables and Environments used for resolving variables in the samplers referenced in this type.

Mandatory: No

types > type > var

Any number of variable definitions, configured with a name and value. Variables specified here override those in the environment if specified.

Mandatory: No

types > type > var > name

The name that is used to identify the variable.

The name must be unique within each variable scope.

Mandatory: Yes

types > type > var > activeTime

Specifies a variable of type activeTime , which refers to an active time in the system.

Mandatory: No

types > type > var > boolean

Specifies a variable of type Boolean, which can take a value of true or false.

Mandatory: No

types > type > var > double

Specifies a variable of type double, which can take a double precision floating point numerical value.

Mandatory: No

types > type > var > externalConfigFile

Specifies a variable which can take the name of an external configuration file.

Mandatory: No

types > type > var > integer

Specifies a variable which can take a numerical integer value.

Mandatory: No

types > type > var > nameValueList

Specifies a variable which can take a list of name value pairs.

Mandatory: No

types > type > var > nameValueList> item

Specifies a single name/value pair in the list.

Mandatory: No

types > type > var > nameValueList> item > name

Specifies the name in a single name/value pair in the list.

Mandatory: No

types > type > var > nameValueList> item > value

Specifies the value in a single name/value pair in the list.

Mandatory: No

types > type > var > regex

Specifies a variable which can take a regular expression.

Mandatory: No

types > type > var > string

Specifies a variable which can take a string.

Mandatory: No

types > type > var > stringList

Specifies a variable which can take a list of strings.

Mandatory: No

types > type > var > stringList > string

Specifies a single string in the string list.

Mandatory: No

types > type > var > macro

Specifies a variable that takes the value from the gateway itself. The macros supported are listed in User Variables and Environments.

Mandatory: No

types > type > sampler

Any number of named references to samplers. These samplers will be loaded each managed entity which references this type. The same sampler should not be referenced multiple times for in a single type, and will generate a validation warning.

Mandatory: No

types > type > samplerInclude

A type definition can contain any number of samplerInclude references. This references a samplerInclude configuration section which will be applied to all managedEntities of this type. SamplerInclude sections define parts of samplers that will be combined into a sampler. For example, a list of processes that will be added to an instance of a processes sampler.

Mandatory: No

types > type > sampler > disabled

Disables the referenced sampler.

Mandatory: No

types > typeGroup

Type groups can be used to group types in the gateway setup. Groups can contain both type definitions and additional type groups.

types > typeGroup > name

Specifies the name of the type group. This name is not used by gateway, and so can be used for descriptive purposes.

Mandatory: Yes