Overview:
As your setups get larger, and start covering an ever increasing real estate you will need to start reusing parts of your setup and putting selected information into reusable variable to reduce your maintenance overhead
Timing:
20 mins
207.5 How can I use elements of my setup in many places?
By studying this tutorial, you will learn how to:
- Create Types and promulgate the values of Variables defined in a type
- Create Variables in Managed entities, Environments and the Operational Environment
- Understand the scope of Variables as they are defined in Entities, Samplers, Types, Environments and the Operating Environment
Each of the three videos explains how to define Variables in different components of a monitoring environment, and illustrates how scoping rules are applied. For more detail on scoping rules, refer to the Gateway Technical Reference Guide.
Features mentioned in this tutorial:
- Samplers: See explanation in 201.1
- Types: The same list of Samplers is often used across a number of Managed Entities, so from an organisational point of view, a Type is used to collect samplers into a single item meaning, for example, that the value of a variable needs to be changed in only one place rather than in each sampler
- Variables: In many parts of the monitoring environment it is possible to specify the value of a setting either by entering data directly, or by referencing a variable. Variables, which are typically configured for settings in a sampler configuration, allows the same sampler definition to be used in several places, and the behaviour of the sampler will depend on the values of the variables at the point at which it is used
- Managed Entities: See definition in Tutorial 201.1
- Environments: If the same group of variables are used repeatedly in multiple places, you can use an Environment to simplify the management of the variables. An Environment is a collection of variables, and is configured using the Environment's top-level section. Each Managed Entity or Type can reference a single Environment which then makes the variables contained within the environment accessible by any samplers defined on that entity or Type. When a Type is added to a Managed Entity using an addTypes setting, an Environment can also be specified for use by the Samplers defined within the Type
- Operating Environment: The Gateway Operating Environment is a configuration section in which settings that will affect the whole Gateway are set
There are three videos in this tutorial covering:
- Samplers and Types
- Managed Entities, Environments and the Operational Environment
- Scope of Variables
All of these videos define the Variable GlobalsampleInterval in different parts of the monitored environment, and illustrate how the value of variables can be promulgated throughout the monitored environment.
This first of three videos illustrates the creation of Types and shows how you can create a Type containing a variable whose value is promulgated to Samplers that are assigned to the Type. Click below to watch the video:
Give it a try
- Fire up the GSE
- Click on Samplers and then New Sampler
- Create a new Sampler and assign it a Plug-in
- Create a second and maybe a third Sampler
- Evaluate and Save the new Samplers
- To create a Type, click on Types in the left hand pane of the GSE
- Click on New type
- Create a new Type
- Assign the samplers to the Type
- On the Advanced Tab, create a variable, select one of the options and give it a value
- Add the Variable to the individual Samplers you created earlier
- Create Managed Entity by right-clicking on Managed Entities in the left hand pane of the GSE
- Click on New Managed Entity
- Assign a NetProbe
- Assign the Type you created earlier
- Exit the GSE
- Check out the Metric for one of the Samplers. What is the Sampling time?
- Fire up the GSE
- Return to the type you created earlier
- Change the value of the Variable
- Evaluate, save the change and exit the GSE
- Return to the Metric for the CPU Sampler. Has the value of the sample interval changed
This video shows how you can create Variables of the same name in a Managed Entity, an Environment and the Operating Environment. The video illustrates how the rules of scope are applied to the Variable depending on where it is defined.
Give it a try
- Create a Variable, GlobslSampleInterval, in a Managed Entity through a Sampler
- Verify that the sample interval has changed by checking the Active Console
- Create an Environment by right-clicking on Environments in the left pane of the GSE
- Click on New Environment and give it a name
- Create a Variable, GlobalSampleInterval as an integer. Give it a value
- Evaluate and Save the Environment
- Go to the Active Console. Has the value of the sample interval changed? If not, why not?
- Click on Operating Environment in the left pane of the GSE
- In the dialog box, create a Variable, GlobalSampleInterval as an integer. Give it a value
- Evaluate and save the Operating Environment
- Go to the Active Console. Has the value of the sample interval changed? If not, why not?
- Return to the Managed Entity in the GSE
- Remove the Variable definition
- Add the Environment that you previously created to the Managed Entity
- Evaluate and Save the change
- Go to the Active Console. Has the value the sampling interval changed? If it has changed, why has it changed?
- go to the Environment you previously created
- Remove the Variable that you created
- Evaluate and save the change
Go to the Active Console. Has the value the sampling interval changed? If it has changed, why has it changed?
This video explains how you can set a variable in different parts of the monitored environment and promulgate the value throughout your monitored environment. The video also illustrated the rules of scope in the Geneos environment. The video uses an Managed Entities and Managed Entity Attributes to explain some of the points, so there is reference to entities called Bonds 1 and Equities 1 and an attribute called AMRS.
Give it a try
- Fire up the GSE
- If you don't already have a Managed Entity with assigned samplers, create one
- Create a Variable, GlobalSampleInterval in the Managed Entity. Make it an integer and give it a value
- Create the same Variable in the Samplers
- Check that the Variable in the Samplers has the same value as the Variable in the Managed Entity
- Evaluate and save the changes
- Check that the value of the sample Interval has changed
- Create a Type by right-clicking on Types in the left hand pane of the GSE
- Click on New Type
- Add the Samplers to the Type
- Add a Variable (GlobalSampleInterval) to the Type
- Evaluate and save the changes
- Go to Active Console and take a look at the sampling interval for one of the samplers
- Has the value of the sampling interval changed? If not, why not?
- Go to the Managed Entity and remove the Variable
- Remove the Samplers from the Managed Entity
- Add a Type to the Managed Entity
- Save and Evaluate the changes
- Return to Active console and verify that the sampling interval has now changed. If it has changed, why has it changed?
- Create an Environment by clicking on Environments in the left pane of the GSE
- Click on New Environment
- Create a Variable, GlobalSampleInterval. Make it an integer and give it a value
- Return to the Managed Entity in the GSE
- Add the Environment that you just created
- Evaluate and save the changes to the Environment and the Managed Entity.
- Go the Active console. Has the value of the sample interval changed. If so, why has it changed?
207.9 How do I share configuration across Gateways?
By studying this tutorial, you will learn how to share configuration across Gateways. This feature enables you to share data items among Gateways and that enables you to change s value in one place. Features covered in this session are:
- Creating an Include file on a Gateway
- Adding a rule to the Include file
- Accessing the Include file on a second Gateway
- Accessing the rule on the second Gateway
Give it a try
Before starting this tutorial, make sure that you have two gateways available. Create an Include file and add a rule to it
- Add a sampler to each Gateway
- Add a Managed Entity to each Gateway
- Fire up the Gateway Setup Editor (GSE) on the first Gateway
- If the rule doesn't exist, create a rule called percent_util (or similar)
- In the Navigation pane, click on "Includes"
- Confirm that you want to create Includes
- Right-click and select "New Include"
- Set the priority of the Include higher than 1
- Add the name of the Include in the Location field
- Set the reload value
- Expand the Include fie in the Navigation pane
- Click on "click to load"
- Confirm that you want to create and load the file
- Expand "Gateway"
- Click on "Rules" and confirm that you want to create Rules
- Locate "Rules" on the first Gateway (SYSMON in the example)
- Expand "Rules" and locate the rule you created earlier (percentutil_rule" in the example)
- Drag the rule to the Rules section in the Include file
- Check that the rule has successfully moved
- Validate and save the change
Make the Include file and the rule accessible from a second Gateway
- Right-click on the second Gateway icon in the Gateway view and select "Configure Gateway"
- Click on "Includes" in the Navigation pane
- Right-click on "Includes"
- Select "New Include"
- Change the priority of the Include so that it is greater than 1
- Set the location to be the same as the previous Include
- Set the "Reload Interval" to 1
- In the Navigation pane, expand the Include file
- Click on "Click to load"
- Confirm that you want to load the file
- Expand "Gateway" in the Navigation pane
- Locate and expand "Rules" in the Include
- Check that the rule is the same as previously
- To create a new path, click on "Add new"
- In the metric for the second gateway (NL_Gateway in this example), locate the cell to which you want to apply the rule
- Drag the cell to the path field in the GSE
- Validate and save the rule
Check that the Rule has been promulgated to the metrics
- In the second Gateway, right-click on the cell (percentUtilisation)
- Select "Show rules"
- Bring up the metric from the first Gateway and verify that the rule is the same
- Right-click in the cell
- Select "Show Rules". Are the rules the same?
Make a change to the rule on one gateway and validate that the change is promulgated to the second Gateway
- Fire up the GSE
- Expand "Includes" in the Navigation Pane"
- Expand the Include file you created earlier
- Click on "click to load"
- Expand "Gateway" in the Navigation Pane
- Expand "Rules" below "Gateway"
- Change one or more values in the rule
- Validate and save the changed rule
- Right-click on the second Gateway icon in the Gateway view and select "Configure Gateway"
- Expand "Includes" in the Navigation pane
- Expand the Include file you created earlier
- Click on "click to load"
- Confirm that you want to load the file
- Click on "Gateway" in the Navigation pane
- Expand "Rules"
- Click on the rule that you created earlier
- Confirm that the changes have been carried through to this Gateway
- Exit the GSE
- Go to the cell (percentUtilisation in the example) in the metric for one of the Gateways
- Right click in the cell and select "show rules"
- Verify that the change has taken effect
- Go to the cell (percentUtilisation in the example) in the metric for the other Gateway
- Right-click in the cell and select "Show Rules"
- Verify that the change has taken effect
Exam Guidance:
Pay attention to the use of include files in a gateway, including narratives on when they are of most use, then on types, variables and environments within the gateways setup to setup properties in just one place for use in many.