Variable methods in IBM Cloud Logs custom dashboards

A variable method defines how the values for the variable will be entered, retrieved, or calculated.

The following methods are availble:

Static-value variables

Use static-value variables to manually define a fixed list of variable values, such as a number or a string of numbers separated by a comma. For example, if you have country names that never change, you might want to create them as a static-value variable. Supports the following variable types: single-string, multi-string.

Query variable

Use query variables to retrieve values from logs or metrics data. For example, a query variable can generate a list of server names, sensor IDs, or data centers, dynamically updating the values by fetching options by using a data source query. Query variables are beneficial when multiple data source instances are managed, specially across diverse environments. Supports the following variable types: single-string, multi-string, numeric.

Text Box

Use a text box to allow users to enter manually input values. Supports the following variable types: single-string, numeric , regex, Lucene, interval

Some methods support both single and multiple values. A query-based method, for example, may return multiple values, but whether the variable accepts multiple selections depends on the value type (single-string vs. multi-string).

Variable types in IBM Cloud Logs custom dashboards

A variable type determines which values the variable selects.

You can choose from different variable types and methods:

How variable values are resolve in IBM Cloud Logs dashboards

Single-value

The user can choose only 1 value for a specific variable.

Variables are inserted as-is.

A None selection resolves to an empty string, for example, Errors for ${service} becomes Errors for.

Multi-value

The user can select multiple values within a specific variable.

Variables are joined with a comma and a space, for example service-a, service-b, service-c.

When the resolved list is too long to fit, the name truncates with an ellipsis and shows the full list in a tooltip on hover.

Include all

The user can select one or more values.

When All (*) is selected, the name shows All (*), or the custom label configured for the Include All option.

Display options in IBM Cloud Logs custom dashboards

Display options in the variable editor control how the variable appears in the dashboard toolbar.

To define how a variable shows in the dashboard, choose one of the following options:

• Name & Value: Displays the variable's display name and its current selection. This is the default option.

• Value Only: Displays the selection alone, without the name.

  Use when the name is obvious from the values and you want to save toolbar space.

• None: The variable does not appear in the toolbar at all.

  Use to hide a variable that a query needs but a viewer should not change. It removes the control from the toolbar.

  For example, you can use it for a variable that only exists to feed another variable. The variable still resolves normally in every query that references it.

When you use the Textbox method for a variable, you also have the option to enable Open as a full row.

• When you turn on Open as a full row, the variable takes an entire row in the dashboard toolbar instead of sharing one with other variables.
• Use it for variables with long values or many selections, where the collapsed control would otherwise truncate.

Format display values in IBM Cloud Logs custom dashboards

Use named regex capture groups to specify which part of the value should be displayed in the values list.

For example, if the query returns values like service-dev or service-prod, use service-(\w+) to display only dev and prod. The variable still resolves to the full original value in queries.

If no groups are defined, the full match is used for both display and value.

Sort values in IBM Cloud Logs custom dashboards

Sort values alphabetically by choosing Alphabetical (asc)or Alphabetical (desc).

Unsorted keeps whatever order the source returned, which for a query-backed variable is the order the query produced.

Filter display values in IBM Cloud Logs custom dashboards

Filter the full list of values using a regex pattern.

Only values that match the pattern will appear in the dashboard.

For example, use /frontend.*/ filters to display values for services starting with frontend.

Adding variables in IBM Cloud Logs custom dashboards

Complete the following steps to add variables to IBM Cloud Logs custom dashboards:

1. Log in to your IBM Cloud account.

2. Access your IBM Cloud Logs instance

3. Click the Dashboard icon > Custom dashboards.

4. In a new or existing dashboard, click .

5. Add a new variable by clicking + Variable.

6. In the Details section, configure the following fields:

   • Variable name: The text that is entered in this field determines how the variable name appears in your query, for example, {{ podvalues }}. No capital letters or spaces are allowed in the variable name.

   • Display name (optional). The text that is entered in this field appears in the selection as part of the drop-down list, for example, "My Pods".

   • Description: Description of the variable.

7. In the Configuration section, select a variable type and a method:

   • Variable type: Choose the type of value this variable should accept to determine how values can be entered or queried.

     Valid values are: Multi-string, Single-string, Regex, Lucene query, and Interval.

   • Method: Choose how values will be provided from a static list, query, or free-text input.

     Valid values are: Static, Query, and Text Box.

8. Configure the Display Options section.

9. Click Save.