This is a general description of the unified analysis extension YAML file and ways to create custom visualizations and configure cards, dashboards, and injections.
To customize the details screen, start with the detailsSettings
and specify the types of information to be included on a unified analysis page. This enables you to customize the page to show all of the data points, charts, and visuals that are most relevant and beneficial to you.
detailsSettings:staticContent:showProblems: trueshowProperties: trueshowTags: trueshowGlobalFilter: trueshowAddTag: truelayout:autoGenerate: falsecards:- key: cpu_memtype: CHART_GROUP- key: diskstype: ENTITIES_LIST
staticContent
Enable or disable static elements like problems, properties, tags, global filter and Add tag option.
Field | Type | Description | Required |
---|---|---|---|
showProblems | boolean | If true , the details screen shows the problem card. | required |
showProperties | boolean | If true , the details screem shows the properties card. | required |
showTags | boolean | If true , the details screem shows the entity tags. | required |
showFilterBar | boolean | If true , the details screen shows the filter bar. | required |
showAddTag | boolean | If true , the details screen shows the Add tag option. | required |
layout
Reference cards that should be shown on the screen (like chart groups or entity lists) or use the automatically generated screen layout.
Field | Type | Description | Required |
---|---|---|---|
autoGenerate | boolean | If true , the screen content is automatically generated. | required |
cards | enum | Possible values for type field: CHART_GROUP , ENTITIES_LIST , EVENTS , LOGS , MESSAGE , METRIC_TABLE , INJECTIONS , BREAK_LINE , HEALTH_CARD , CARD_GROUP . | optional |
The detailsInjections
field defines injections for the entity details page. This information can be used to better evaluate user experience and also help with root-cause analysis.
Injections must be supported by the screen—the layout needs to include an injected cards placeholder.
detailsInjections:- type: CHART_GROUPentitySelectorTemplate: type(custom:host), toRelationship.sameAs($(entityConditions))key: injectedChartGroups- type: ENTITIES_LISTkey: injectedListwidth: HALF_SIZE- type: EVENTSkey: injectedEventswidth: FULL_SIZE
Field | Type | Description | Required |
---|---|---|---|
type | enum | Defines the type of card available to inject. Possible values: CHART_GROUP , ENTITIES_LIST , EVENTS , LOGS , MESSAGE , HEALTH_CARD , CARD_GROUP , METRIC_TABLE . | required |
key | String | The unique key of the card, which is used to reference desired card configuration. | required |
entitySelectorTemplate | String | Entity selector pointing to related entities. It can serve multiple purposes—selecting the entity where the chart will be displayed and filtering them based on certain rules or relating entities. It is used in conjunction with
For example, when the card with the following configuration is displayed on the host page.
The
| optional |
width | enum | A value that determines how much vertical space the card is taking. Possible values: HALF_SIZE , FULL_SIZE . | optional |
The detailsFilter
field defines filters for the entity details screen. It enables you to customize the page to show only the data you want to see. It automatically displays metric dimension filters if there are any dimension splits on the screen (chart or metric table). To display only metric dimension filters, define it as empty (detailsFilters: {}
).
detailsFilters:relationships:- type(HOST_GROUP), toRelationship.isInstanceOf($(entityConditions))- type(AZURE_REGION), fromRelationship.isSiteOf($(entityConditions))entityFilters:- displayName: filtersfilters:- type: entityNamedisplayName: namefreeText: falsemodifier: containsdefaultSearch: truedistinct: falseentityTypes:- my:interface
relationships
You can enable filtering by configuring the relationship between screen entity type and related entity type. For example, filter process list by host name:
relationships:- type(HOST) AND toRelationship.isProcessOf($(entityConditions))
You can also configure the filtering on multiple levels. For example, filter the processes by host group name:
relationships:- type(HOST) AND toRelationship.isProcessOf($(entityConditions))- type(HOST) AND fromRelationship.isInstanceOf(type(HOST_GROUP))
entityFilters
The block that defines the groups of filters (these are displayed slightly grayed out in the filtering list).
Field | Type | Description | Required |
---|---|---|---|
filters | Array | The actual filters that are part of this group. | required |
type | String | Must reference an attribute of the entity you are filtering. Note: every entity has entityName as a default attribute. | required |
displayName | String | How this filter is labelled within the web UI. | required |
freeText | boolean | If true , the user can freely type text; otherwise, they must select from a list of suggestions. Note: only default attributes such as entityName are capable of offering list of suggestions. | required |
modifier | boolean | When freeText is true, this defines how the text should be matched against the attribute. When freeText is false, this must be omitted. Note: All non-default attributes must match as equals regardless of this option. | optional |
defaultSearch | boolean | If true , if the user starts typing without selecting a filter first, this filter is selected by default. Only one filter within the filtering block may have this enabled. | optional |
distinct | boolean | If true , only one instance of this filter can be applied. | required |
entityTypes | Array | A mandatory list of entity types that this filter applies to. If you omit this, your filtering bar just shows a spinning wheel because of the incomplete definition. | optional |
The listSettings
section enables you to customize the list view of the unified analysis page. You can change the selection and order of columns, how the list is sorted, and the number of rows to display.
listSettings:staticContent:showGlobalFilter: trueheader:title: My hostsdescription: My hosts listicon: hostlayout:autoGenerate: falsecards:- type: CHART_GROUPkey: chart- type: ENTITIES_LISTkey: entitiesList- type: INJECTIONS
staticContent
requiredEnable or disable static elements like problems, properties, tags, global filter, and the Add tag option.
Field | Type | Description | Required |
---|---|---|---|
showProblems | boolean | If true , the details screen shows the problem card. | optional |
showProperties | boolean | If true , the details screem shows the properties card. | optional |
showTags | boolean | If true , the details screem shows the entity tags. | optional |
showGlobalFilter | boolean | If true , the details screen shows the filter bar. | required |
showAddTag | boolean | If true , the details screen shows the Add tag option. | optional |
header | Object | The definition of the page header. | optional |
breadcrumbs | Array | A list of breadcrumbs leading to the page. | optional |
hideDefaultBreadcrumb | boolean | If true , the default breadcrumb for the current page is hidden. | optional |
layout
requiredReference cards that should be shown on the screen (like chart groups or entity lists) or use the automatically generated screen layout.
Field | Type | Description | Required |
---|---|---|---|
autoGenerate | boolean | If true , the screen content is automatically generated. | required |
cards | enum | Possible values for type field: CHART_GROUP , ENTITIES_LIST , MESSAGE , INJECTIONS , BREAK_LINE . | optional |
The listInjections
field defines injections for entity details screen. Injections must be supported by the screen—the layout needs to include an injected cards placeholder.
listInjections:- type: CHART_GROUPkey: injectedChartGroups- type: ENTITIES_LISTkey: injectedListwidth: HALF_SIZE
Field | Type | Description | Required |
---|---|---|---|
type | enum | Defines the type of card available to inject. Possible values: CHART_GROUP , ENTITIES_LIST , MESSAGE , METRIC_TABLE . | required |
key | String | The unique key of the card, which is used to reference desired card configuration. | required |
The listFilters
field defines filters on the list page.
listFilters:relationships:- type(HOST_GROUP), toRelationship.isInstanceOf($(entityConditions))- type(AZURE_REGION), fromRelationship.isSiteOf($(entityConditions))entityFilters:- displayName: filtersfilters:- type: entityNameentityTypes:- HOST_GROUP- AZURE_REGIONfreeText: falsedisplayName: namedistinct: true
relationships
You can enable filtering by configuring the relationship between screen entity type and related entity type. For example, filter process list by host name:
relationships:- type(HOST) AND toRelationship.isProcessOf($(entityConditions))
You can also configure the filtering on multiple levels. For example, filter the processes by host group name:
relationships:- type(HOST) AND toRelationship.isProcessOf($(entityConditions))- type(HOST) AND fromRelationship.isInstanceOf(type(HOST_GROUP))
entityFilters
The list of entity filters. For generic entities, the only filter types with suggestions are entityName
, tag
, healthState
, and ipAddress
/ dt.ip_addresses
. Any custom attributes must be set to freeText: true
with modifier: equals
. There are no suggestions supported, so you must type the exact value to filter.
Field | Type | Description | Required |
---|---|---|---|
filters | Array | The actual filters that are part of this group. | required |
type | String | Must reference an attribute of the entity you are filtering. Note: every entity has entityName as a default attribute. | required |
displayName | String | How this filter is labelled within the web UI. | required |
freeText | boolean | If true , the user can freely type text; otherwise, they must select from a list of suggestions. Note: only default attributes such as entityName are capable of offering list of suggestions. | required |
modifier | boolean | When freeText is true, this defines how the text should be matched against the attribute. When freeText is false, this must be omitted. Note: All non-default attributes must match as equals regardless of this option. | optional |
defaultSearch | boolean | If true , if the user starts typing without selecting a filter first, this filter is selected by default. Only one filter within the filtering block may have this enabled. | optional |
distinct | boolean | If true , only one instance of this filter can be applied. | required |
entityTypes | Array | A mandatory list of entity types that this filter applies to. If you omit this, your filtering bar just shows a spinning wheel because of the incomplete definition. | optional |
The propertiesCard
field displays the entity properties that are shown on the card as key-value pairs. By default, all available attribute properties are displayed.
propertiesCard:properties:- type: RELATIONrelation:entitySelectorTemplate: NOT VALIDATED IN SCHEMAdisplayName: default- type: ATTRIBUTEattribute:key: attributedisplayName: Attribute
properties
requiredUse this configuration to specify the properties card.
Field | Type | Description | Required |
---|---|---|---|
type | enum | Defines the type of property. Possible values: RELATION , ATTRIBUTE . | optional |
RELATION
Enables you to specify the relation to the specific entity.
Field | Type | Description | Required |
---|---|---|---|
entitySelectorTemplate | String | An entity selector that is used to retrieve the selected entities. It can serve multiple purposes—selecting the entity where the chart will be displayed and filtering them based on certain rules or relating entities. It is used in conjunction with
For example, when the card with the following configuration is displayed on the host page.
The
| required |
displayName | String | The name of the relation. | required |
fallbackMessage | String | Displays additional message if no entity is found. By default, the whole property is hidden. | optional |
ATTRIBUTE
Enables you to overwrite attribute display options.
Field | Type | Description | Required |
---|---|---|---|
key | String | Used to reference the desired attribute. | required |
displayName | String | The name of the attribute. | optional |
The chart group cards enable you to visualize the specified metrics in dedicated charts.
metricSelector
expression specifies the metrics your chart is based on. For more information, see Metrics API - Metric selector. The examples below use simple metric selector expressions referring directly to the metric keys.chartsCards:- key: chartGroupconditions:- NOT VALIDATED IN SCHEMAnumberOfVisibleCharts: 2charts:- displayName: Chartconditions:- NOT VALIDATED IN SCHEMAvisualizationType: GRAPH_CHARTgraphChartConfig:visualization:themeColor: DEFAULTseriesType: LINEmetrics:- metricSelector: NOT VALIDATED IN SCHEMA- metricSelector: builtin:host.cpu.usage:avgvisualization:themeColor: DEFAULTseriesType: LINE- displayName: Chart2visualizationType: PIE_CHARTpieChartConfig:metric:metricSelector: NOT VALIDATED IN SCHEMAdefaultAggregation: AVGshowLegend: truethemeColor: ORANGE- displayName: Chart3visualizationType: SINGLE_VALUEsingleValueConfig:metric:metricSelector: NOT VALIDATED IN SCHEMAdisplayName: Single valuedefaultAggregation: COUNTshowSparkline: trueshowTrend: true
Field | Type | Description | Required |
---|---|---|---|
key | String | The unique key of the card, which is used to reference desired card configuration | required |
conditions | Array | Defines the conditions that need to be fulfilled for the chart group card to be visible. | optional |
numberOfVisibleCharts | Integer | The number of charts that are visible on the unified analysis page. | required |
mode | enum | Defines the chart group behavior and interactivity. Possile values: NORMAL , STATIC .1 | required |
NORMAL
mode enables you to interact with the charts (view different data points or zoom in/out). Charts with STATIC
mode are presented in a fixed, restricted manner.
charts
Field | Type | Description | Required |
---|---|---|---|
displayName | String | The title of the card. | required |
conditions | Array | Defines the conditions that need to be fulfilled for the chart group card to be visible. | optional |
visualizationType
The visualizationType
defines the type for your chart: a graph chart GRAPH_CHART
, a pie chart PIE_CHART
, or a single value SINGLE_VALUE
. If you don't specify the visualization type, the graph chart is rendered by default.
GRAPH_CHART
Field | Type | Description | Required |
---|---|---|---|
visualization | enum | Enables you to define a theme color, and series type (COLUMN , LINE or AREA ). You can also enable showing the axis legend by setting the showLegend flag to true . | required |
metrics | Array | Defines how to retrieve data for a single line in the chart. | required |
thresholds | Array | Defines thresholds after which the background of the chart will change the color to the selected one. | optional |
metricSelector
A metric selector expression for a dedicated metric line.
Field | Type | Description | Required |
---|---|---|---|
visualization | enum | Enables you to define a theme color, and series type (COLUMN , LINE or AREA ). You can also enable showing the axis legend by setting the showLegend flag to true . | optional |
PIE_CHART
Field | Type | Description | Required |
---|---|---|---|
metric | Object | Defines how to retrieve data for the pie chart. | required |
defaultAggregation | enum | Defines default aggregation of the chart timeseries. If not defined or selected one is not supported, it is deduced from metrics metadata. | optional |
SINGLE_VALUE
Field | Type | Description | Required |
---|---|---|---|
metric | Object | Defines how to retrieve data for the single chart. | required |
displayName | String | Defines the name of the value. | optional |
defaultAggregation | enum | Defines default aggregation of the chart timeseries. If not defined or selected one is not supported, it is deduced from metrics metadata. | optional |
showSparkline | boolean | If true , the sparkline is visible. | optional |
showTrend | boolean | If true , the trend is visible. | optional |
thresholds | Array | Defines thresholds after which the background of the chart will change the color to the selected one. | optional |
foldTransformation | enum | Defines transformation method, which folds data into single value. Possible values: AUTO , LAST_VALUE , MAX , MIN , SUM , MEDIAN , VALUE , PERCENTILE_10 , PERCENTILE_75 , PERCENTILE_90 . | optional |
ConditionName|param1key=param1value|param2key=param2value
Condition | Parameters | Minimum schema version | Description |
---|---|---|---|
demo | 224 | Used to demonstrate the conditions feature. | |
isSaaS | 233 | Indicates if the server deployment type is SaaS. | |
featureFlag | Feature flag key | 233 | Validates the status of a specific feature flag. |
entityAttribute | Dynamic parameters1 | 231 | Checks if the screen's monitored entity possesses certain attributes with specified values or if they exist with any value. |
relatedEntity | entitySelectorTemplate | 230 | Validates the existence of a specified related entity in the environment. |
extensionConfigured | extensionId , aboveOrEqualVersion , belowOrEqualVersion , featureSets , activatedOnHost 2 | 243 | Validates the presence of a specified extension in the environment, considering other parameters. |
uiPermission | Specified UI permision | 243 | Confirms if you possess a specified permission (for example, CONFIG_WRITE ). |
isActive | 246 | Determines if the screen's monitored entity is active. | |
serviceType | Type of the service | 246 | Confirms the type of the service. The scope limited to METype.SERVICE details screens. |
typeExists | Type of the service | 248 | Checks if a specified METype service is present in the environment. |
platform | 254 | Checks 3rd generation compatibility. | |
metricAvailable | metric 3, lastWrittenWithinDays 4 | 256 | Verifies if a given metric key has associated metadata and the last time it was updated. |
When parameters are provided with a specific value, they are formatted as key=value
. The system will verify the exact match of this key-value
pair. If only the key is provided without any accompanying value, the system will simply check if that key is present using the .exists()
method.
The extension is configured to operate on the current host.
Metric key
The specified number of days within which the system checks the most recent updates.
The entities list card displays other entities that are related to the focused entity. The YAML file below lists all Synology disks mapped to an instance of DiskStation Manager on which the details screen focuses.
entitySelectorTemplate
expression specifies the entities to list on the card. For more information, see Environment API v2 - Entity selector.type(syn:disk),fromRelationships.runsOn($(entityConditions))
lists the entities of type syn:disk
that have a relationship of from
direction and runsOn
type to the syn:diskmanager
represented via the $(entityConditions)
placeholder that stands for a focused entity.entitiesListCards:- key: disksdisplayName: Synology diskspageSize: 10displayCharts: falseentitySelectorTemplate: "type(syn:disk),fromRelationships.runsOn($(entityConditions))"displayIcons: trueenableDetailsExpandability: truenumberOfVisibleCharts: 2columns:- type: ATTRIBUTEattribute:key: some_attributedisplayName: Some attribute- type: RELATIONrelation:entitySelectorTemplate: type("syn:partition"),fromRelationship.isChildOf($(entityConditions))displayName: PartitionsdisplayAmount: falsefallbackMessage: "no partition"filtering:relationships:- type(syn:partition), fromRelationship.isChildOf($(entityConditions))entityFilters:- displayName: filtersfilters:- type: entityNamedisplayName: namefreeText: truemodifier: containsdefaultSearch: truedistinct: falseentityTypes:- my:interface- type: entityNamedisplayName: Partition namefreeText: truemodifier: containsdefaultSearch: falsedistinct: falseentityTypes:- syn:partition
Field | Type | Description | Required |
---|---|---|---|
key | String | The unique key of the card, which is used to reference desired card configuration. | required |
displayName | String | The card title. | optional |
pageSize | Integer | The number of rows visible on a single page. | required |
displayCharts | boolean | If true , charts with aggregated data appears above table. | required |
entitySelectorTemplate | String | The entity selector is used to find entities that are to be displayed on the list. It can serve multiple purposes—selecting the entity where the chart will be displayed and filtering them based on certain rules or relating entities. It is used in conjunction with
For example, when the card with the following configuration is displayed on the host page.
The
| optional |
displayIcons | boolean | If true , the name column displays the icon of the entity. | required |
enableDetailsExpandability | boolean | If true , rows can be expanded with charts related to that row dimension values. | required |
numberOfVisibleCharts | Integer | The number of charts that are visible on the unified analysis page. | required |
displayProblemImpactWidget | boolean | If true , a widget indicating that some entities are not healthy will be displayed above the list. Make sure there is visible filtering with the health state filter. | optional |
columns | Object | Additional attribute or relation columns. | optional |
filtering | Object | The filtering inside the entity list card. It affects only that card's table and chart group. | optional |
columns
Additional columns that are displayed between Name and chart columns. There are 2 types available: ATTRIBUTE and RELATION.
RELATION
Enables you to specify the relation to the entity (1:1 relation) or list of entities (1:n relation).
Field | Type | Description | Required |
---|---|---|---|
entitySelectorTemplate | String | An entity selector that is used to retrieve the selected entities. It can serve multiple purposes—selecting the entity where the chart will be displayed and filtering them based on certain rules or relating entities. It is used in conjunction with
For example, when the card with the following configuration is displayed on the host page.
The
| required |
displayName | String | The name of the column. | required |
displayAmount | String | If false , entities are displayed as a list (up to 20 entities). If true , the number of related entities is displayed as a link to the list screen. The linked list is prefiltered only if it has configured listFilters with appropriate relationship and entityName filter (freeText: true and modifier: contains ). | required |
fallbackMessage | String | Displays additional message if no entity is found. | optional |
ATTRIBUTE
Enables you to specify custom attribute column.
Field | Type | Description | Required |
---|---|---|---|
key | String | Used to reference the desired attribute. | required |
displayName | String | The name of the attribute. | required |
The events cards display the events related to specified entities.
eventsCards:- key: eventsdisplayName: EventsentitySelectorTemplates:- "$(entityConditions)",- "type(CONTAINER_GROUP_INSTANCE),fromRelationships.isInstanceOf($(entityConditions))",- "type(PROCESS_GROUP_INSTANCE),fromRelationships.isPgiOfCgi(type(CONTAINER_GROUP_INSTANCE),fromRelationships.isInstanceOf($(entityConditions)))"showFiltering: trueshowPagination: truepageSize: 10
Field | Type | Description | Required |
---|---|---|---|
key | String | The unique key of the card, which is used to reference desired card configuration. | required |
displayName | String | The card title. If not set, card are named Events . | optional |
entitySelectorTemplates | Array | The list of entity selector templates. It defines where the events are gathered from. If empty, the events are gathered for current entity. | optional |
showFiltering | boolean | If true , the filtering bar displays above events chart. | required |
showPagination | boolean | If true , the Show more action is available under events list. | required |
pageSize | Integer | The number of rows visible at card load. | required |
description | String | The description of the card. | optional |
eventSelectorTemplate | String | An event selector that is used to fetch events for related entities. | optional |
displayChart | boolean | Show or hide the chart in the card. | optional |
The logsCards
field specifies the behavior of the logs card and has the same functionality as Log viewer. It consists of a bar chart representing different log occurrences during selected timeframe and detailed table where each log is an entry with additional properties like: timestamp, status, content.
logsCards:- key: logsdisplayName: LogsenablePaging: truefilterQuery: event.type!="k8s" AND ($(logEntityAttributeKey) inEntitySelector "$(entityConditions)" OR dt.entity.container_group_instance inEntitySelector "type(CONTAINER_GROUP_INSTANCE),fromRelationships.isInstanceOf($(entityConditions))" OR dt.entity.process_group_instance inEntitySelector "type(PROCESS_GROUP_INSTANCE),fromRelationships.isPgiOfCgi(type(CONTAINER_GROUP_INSTANCE),fromRelationships.isInstanceOf($(entityConditions)))")showFiltering: truepageSize: 10
Field | Type | Description | Required |
---|---|---|---|
key | String | The unique key of the card, which is used to reference desired card configuration. | required |
displayName | String | The card title. | optional |
enablePaging | boolean | If true , enables paging of the log results in the table. | optional |
filterQuery | String | The predefined filtering for the log table. It is possible to to use LQL syntax also to more complex cases that include entity selectors with unified analysis placeholders in format: expression {attribute} inEntitySelector "{entitySelector}" to display logs of related entities. For example, dt.entity.host inEntitySelector "type(PROCESS_GROUP_INSTANCE) AND fromRelationship.isProcessOf($(entityConditions))" . | optional |
showFiltering | boolean | Controls the visibility of the filter bar. | optional |
pageSize | Integer | The number of rows visible on a single page. | optional |
description | String | The description of the card. | optional |
displayChart | boolean | Show or hide the chart in the card. | optional |
The messageCards
field specifies the behavior of the message card, like visualization options, theme, or text.
messageCards:- key: message-cardtype: CARDcard:text: internal texttheme: MAINdisplayName: Message Card- key: message-card2type: MESSAGEmessage:text: internal texttheme: INFO
Field | Type | Description | Required |
---|---|---|---|
key | String | The unique key of the card, which is used to reference desired card configuration. | required |
type | enum | Defines the type of your message card. The possible values are: CARD , MESSAGE . | required |
CARD
Displays the message in the card format with title, description and buttons.
Field | Type | Description | Required |
---|---|---|---|
text | String | Defines the description of the card. | required |
theme | enum | Defines the color theme of the card. The possible values are: WARNING , MAIN , CTA . | required |
displayName | String | Defines the title of the card. | optional |
MESSAGE
Displays the message in the card format with description only.
Field | Type | Description | Required |
---|---|---|---|
text | String | Defines the description of the card. | required |
theme | enum | Defines the color theme of the message. The possible values are: INFO , WARNING , ERROR . | required |
The problemsCard
field specifies the behavior of the problems card.
problemsCard:entitySelectorTemplates:- NOT VALIDATED IN SCHEMA- NOT VALIDATED IN SCHEMA1- NOT VALIDATED IN SCHEMA2
Field | Type | Description | Required |
---|---|---|---|
entitySelectorTemplates | Array | Up to 10 entity selectors, used to fetch data for related entities. | optional |
The actions
field defines actions that are available from the menu.
actions:- actionScope: GLOBAL_DETAILSactions:- actionExpression: actionName|key1=value1- actionScope: CHART_GROUPkey: chartactionLocation: CHARTactions:- actionExpression: actionName|key1=value1- actionScope: ENTITIES_LISTkey: entitiesListactionLocation: TABLE_ENTRYactions:- actionExpression: actionName|key1=value1
Field | Type | Description | Required |
---|---|---|---|
actionScope | enum | The defined action appears in the settings of the chosen card type. Possible values: GLOBAL_DETAILS , GLOBAL_LIST , PROPERTIES , PROBLEMS , CHART_GROUP , ENTITIES_LIST , EVENTS , LOGS , METRIC_TABLE . | required |
key | String | You can set the key if you want the action to be available only in one specific card. To add this actions in every card of this type, leave it empty. | required |
actionExpression | String | Defines the action expression. | required |
actionLocation | enum | Defines the location of your created action. Possible values: HEADER , CHART , TABLE_ENTRY . | optional |
ActionName|param1key=param1value|param2key=param2value
Action | Parameters | Minimum schema version | Description |
---|---|---|---|
configuration | 221 | Creates a link to the entity configuration page. For example, host settings. | |
relatedEntityConfiguration | entitySelectorTemplate , name | 234 | Creates a link to the entity configuration page. For example, PGI settings from the host page. |
settings | name , scopeClass 1, scopeIdentifier 2, schemaId 3 | 236 | Creates a link to the specified Settings 2.0 topic configuration UI. |
hubCapability | text 4, hubCapability 5 | 243 | Creates a link to the specified Dynatrace Hub capability. |
hubExtension | text 4, extensionId 6 | 243 | Creates a link to the specified Extension in Dynatrace Hub. |
relatedEntityScreen | entitySelectorTemplate , name | 253 | Creates a link to the related entity unified analysis page. |
platform.intent | json 7, label , appId , intentId | 254 | Platform intent action. |
smartscape | 255 | Redirects to smartscape. |
Settings scope class
Settings scope identifier
Settings schema ID
Action display name
Hub capability URL part
Extension ID used as URL part
Entire intent JSON
Action | Parameters | Valid for condition | Minimum schema version | Description |
---|---|---|---|---|
core.editConfig | UAScreenFeatureFlags.ENABLE_CONFIG_BUTTONS | 218 | Redirects to the entity's settings page and creates links for all its subtypes. | |
core.shareScreenUrl | Whole screen scope | 218 | Provides a link for sharing feedback. | |
core.share.feedback | Whole screen scope | 218 | Opens a feedback sharing form. | |
core.dataExplorer | Chart element type | 223 | Redirects charts to Data Explorer. | |
core.alerting | CONFIG_WRITE permissions, Chart element type | 224 | Redirects charts to set alerts on the selected metric. | |
core.pinToDashboard | Chart or Whole Services screen scope with UAScreenFeatureFlags.ENABLE_PIN_TO_DASHBOARD | 224 | Pins charts or entire services to the dashboard. | |
core.problems | - | 224 | Navigates to the Problems section. | |
core.screenType | UAScreenFeatureFlags.ENABLE_CONFIG_BUTTONS | 224 | Creates multiple predefined screen type actions. | |
core.singleCard | UAScreenFeatureFlags.ENABLE_SINGLE_CARD_BUTTONS | 232 | Displays a single card view. | |
core.logs.createMetric | Log card element type | 233 | Redirects to log settings to create a log metric. | |
core.opt.out | Whole screen scope | 235 | Navigates to the classic page view. | |
core.useLocalConfig | UAScreenFeatureFlags.ENABLE_USE_LOCAL_CONFIG_BUTTON | 236 | Activates the Local Config Mode. | |
core.sidebar | screenTypeExpression 1 | UAScreenFeatureFlags.ENABLE_SIDE_BAR_BUTTONS | 244 | Opens the sidebar. |
core.problems.details | pid 2 | Details screen | 243 | Navigates to specific problem details. |
core.logs.filtered | Log card element type | 246 | Redirects log cards to the Log Viewer. | |
core.slos.create | CONFIG_WRITE permissions, Slo List element type | 255 | Redirects charts to create a Service Level Objective (SLO). |
Screen type expression to be rendered in the sidebar
Problem ID
Metric table is a graphical representation of the metrics data related to the same dimension set.
metricTableCards:- key: metricTablepageSize: 5displayCharts: trueenableDetailsExpandability: truenumberOfVisibleCharts: 2filtering: {}charts:- displayName: Chartconditions:- NOT VALIDATED IN SCHEMAvisualizationType: GRAPH_CHARTgraphChartConfig:visualization:themeColor: DEFAULTseriesType: LINEmetrics:- metricSelector: NOT VALIDATED IN SCHEMA- metricSelector: builtin:process.cpu:splitBy("process.pid","process.parent_pid","process.executable.name","process.executable.path","process.command_line","process.owner", "dt.entity.process_group_instance")visualization:themeColor: DEFAULTseriesType: LINEconditions:- NOT VALIDATED IN SCHEMA
Field | Type | Description | Required |
---|---|---|---|
key | String | The unique key of the card, which is used to reference desired card configuration. | required |
pageSize | Integer | The number of rows visible on a single page. | required |
displayCharts | boolean | If true , charts with aggregated data appears above the table. | required |
enableDetailsExpandability | boolean | If true , rows can be expanded with charts related to that row dimension values. | required |
numberOfVisibleCharts | Integer | Number of visible charts. | required |
charts | Object | Define the charts to display timeseries data in the table. Table columns are based on the dimensions from the metrics results of those charts. Make sure the metrics of all charts have the same dimensions in a result. | optional |
conditions | Array | Conditions for displaying the chart. | optional |
filtering | Object | The filtering inside the metric table card. It affects only that cards table and chart group. It automatically displays metric dimension filters if there are any dimension splits. To display only metric dimension filters, define it as empty (detailsFilters: {} ). | optional |
Health cards provide a visual representation of specific metrics within the Dynatrace UI. Each card can be tailored to display up to six distinct tiles, each representing a unique metric or data point.
Health tile can be used as navigation button to specify element on the page that will give more details about that metric.
healthCards:- key: health_cardtiles:- displayName: UptimemetricSelector: builtin:host.uptimedisplayMetricValue: 'true'foldTransformation: LAST_VALUE- displayName: CPUmetricSelector: builtin:host.cpu.usage:avgdisplayMetricValue: 'true'foldTransformation: LAST_VALUEanchor:cardName: Host performancechartName: CPU usage- displayName: Available memorymetricSelector: builtin:host.mem.avail.pctdisplayMetricValue: 'true'foldTransformation: LAST_VALUEanchor:cardName: Host performancechartName: Memory usage- displayName: NetworkmetricSelector: (builtin:host.net.nic.trafficIn:merge("dt.entity.network_interface"):avg)+(builtin:host.net.nic.trafficOut:merge("dt.entity.network_interface"):avg)additionalMetricSelectors:collection:- builtin:host.net.nic.trafficIn:merge("dt.entity.network_interface")- builtin:host.net.nic.trafficOut:merge("dt.entity.network_interface")displayMetricValue: 'true'foldTransformation: LAST_VALUEanchor:cardName: Host performancechartName: Traffic
Field | Type | Description | Required |
---|---|---|---|
key | String | Unique key, which is used to map to this health card in the screen layout config. | required |
tiles | Array | Collection of tile definitions in the health card. Each tile can display a specific metric. A health card can have up to 6 tiles. | optional |
tiles
Field | Type | Description | Required |
---|---|---|---|
displayName | String | The name of the health card tile. | required |
metricSelector | String | Used to relate problems and specify the metric displayed on the tile. | required |
additionalMetricSelectors | Array | Used to relate problems. Hidden in the UI. | optional |
displayMetricValue | boolean | Determines whether the metric value should be displayed on the tile. | optional |
foldTransformation | Enum | Defines transformation method, which folds data into single value. Possible values: AUTO , LAST_VALUE , MAX , MIN , SUM , MEDIAN , VALUE , PERCENTILE_10 , PERCENTILE_75 , PERCENTILE_90 . | required |
anchor | Object | Defines an element to redirect to when the tile is selected. This can be a specific card or chart name. | optional |