Skip to main content
Data Infrastructure Insights

Using annotations

Contributors netapp-alavoie dgracenetapp
PDFs

You create annotations and assign them to assets you monitor. Annotations are notes that provide information about an asset, such as physical location, end of life, storage tier, or volume service levels.

Defining annotations

Using annotations, you can add custom business-specific data that matches your business needs to assets. While Data Infrastructure Insights provides a set of default annotations, such as asset life cycle (birthday or end of life), building or data center location, and tier, you might find that you want to view data in other ways.

The data in custom annotations supplements device data already collected, such as switch manufacturer, number of ports, and performance statistics. The data you add using annotations is not discovered by Data Infrastructure Insights.

Before you begin

  • List any industry terminology to which environment data must be associated.

  • List corporate terminology to which environment data must be associated.

  • Identify any default annotation types that you might be able to use.

  • Identify which custom annotations you need to create. You need to create the annotation before it can be assigned to an asset.

Use the following steps to create an annotation.

Steps

  1. In the Data Infrastructure Insights menu, click Observability > Enrich > Annotations

  2. Click + Annotation to create a new annotation.

  3. Enter a Name, Description, and type for the new annotation.

    For example, enter the following to create a text annotation that defines the physical location of an asset in Data Center 4:

    • Enter a name for the annotation, such as "Location"

    • Enter a description of what the annotation is describing, such as "Physical location is Data Center 4"

    • Enter the 'type' of annotation it is, such as "Text".

Manually assigning annotations to assets

Assigning annotations to assets helps you sort, group, and report on assets in ways that are relevant to your business. Although you can assign annotations to assets of a particular type automatically using annotation rules, you can assign annotations to an individual asset by using its asset page.

Before you begin

  • You must have created the annotation you want to assign.

Steps

  1. Log in to your Data Infrastructure Insights environment.

  2. Locate the asset to which you want to apply the annotation.

    • You can locate assets by querying, choosing from a dashoard widget, or search. When you have located the asset you want, click the link to open the asset's landing page.

  3. On the asset page, in the User Data section, click + Annotation.

  4. The Add Annotation dialog box displays.

  5. Select an annotation from the list.

  6. Click Value and do either of the following, depending on type of annotation you selected:

    • If the annotation type is list, date, or Boolean, select a value from the list.

    • If the annotation type is text, type a value.

  7. Click Save.

If you want to change the value of the annotation after you assign it, click the annotation field and select a different value.
If the annotation is of list type for which the Add new values on the fly option is selected, you can type a new value in addition to selecting an existing value.

Assigning annotations using annotation rules

To automatically assign annotations to assets based on criteria that you define, you configure annotation rules. Data Infrastructure Insights assigns the annotations to assets based on these rules. Data Infrastructure Insights also provides two default annotation rules, which you can modify to suit your needs or remove if you do not want to use them.

Creating annotation rules

As an alternative to manually applying annotations to individual assets, you can automatically apply annotations to multiple assets using annotation rules. Annotations set manually on an individual asset pages take precedence over rule-based annotations when Insight evaluates the annotation rules.

Before you begin

You must have created a query for the annotation rule.

About this task

Although you can edit the annotation types while you are creating the rules, you should have defined the types ahead of time.

Steps

  1. Click Manage > Annotation rules

    The Annotation Rules page displays the list of existing annotation rules.

  2. Click + Add.

  3. Do the following:

    1. In the Name box, enter a unique name that describes the rule.

      This name will appear in the Annotation Rules page.

    2. Click Query and select the query that is used to apply the annotation to assets.

    3. Click Annotation and select the annotation you want to apply.

    4. Click Value and select a value for the annotation.

      For example, if you choose Birthday as the annotation, you specify a date for the value.

    5. Click Save

    6. Click Run all rules if you want to run all the rules immediately; otherwise, the rules are run at a regularly scheduled interval.