Ownership app

Latest Dynatrace

The Ownership app enables you to take advantage of prebuilt actions for ownership management within automation workflows.

To avoid creating ownership teams from scratch within Dynatrace, you take advantage of a prebuilt action to import ownership teams from:

User group data that has already been programmatically retrieved from Microsoft Entra ID via Workflows.
A JSON source.

You can use other prebuilt actions for building workflows that involve querying for an entity's ownership team and related contact information. With these actions, you can extract ownership data about an entity and integrate with other apps to send Slack notifications or Jira updates to entity owners based on different types of triggers.

See Capabilities for details.

Installation

To use Ownership app workflow actions, you first need to install the Ownership app from Dynatrace Hub. Once installed, you can only use the Ownership app via actions in Workflows.

In Dynatrace Hub , search for ownership.
Select the Ownership app and then select Install.
Set up the permissions described below.

Once installed, you need to use the prebuilt ownership actions from within the Workflows app .

Permissions

The Ownership app requires the following permissions.
- environment-api:entities:read—Read entities.
- settings:objects:read—Read settings 2.0 objects.
- settings:schemas:read—Read settings 2.0 schemas.
Additionally, you require the following primary permissions in Workflows.

Open Workflows and go to Settings > Authorization Settings.
- app-engine:apps:run—Enables listing and running apps; provides basic access to the Launcher.
- app-engine:functions:run—Enables use of the function executor.
Alternatively (in addition to Ownership app permissions), you can set up users with the AppEngine user policy.

Capabilities

The core capabilities of the Ownership app are contained in these prebuilt actions for Workflows . The Ownership app's value lies in the ability to combine these actions with other tasks and actions to create workflows for team import, notifications, task assignment, and other use cases.

`import_teams`

This action provides two modalities for importing structured team information into Dynatrace settings for the purpose of applying entity ownership.

Entra ID groups

The import_teams action takes the results of the prebuilt get_groups action, which gets user group data from Microsoft Entra ID, and stores the data as ownership teams within Dynatrace settings. In this way, you can use your Entra ID information to assign team owners to Dynatrace-monitored entities without having to create teams from scratch.
1. Make sure that the get_groups action precedes the import_teams action within the same workflow. We recommend that import_teams should immediately follow get_groups.
  If you use the import_teams action after the get_groups action in your workflow to add Entra ID groups to the list of ownership teams:
  You always need to include id and displayName in get_groups; these fields are mapped to the imported ownership team's Team identifier and Team name, respectively.
  We recommend that you always include the mailNickname parameter in get_groups. This field has unique values in Entra ID and is set as a unique, human-readable Supplementary Identifier for your imported ownership team within Dynatrace.
  The Object Id from Entra ID, imported via the id parameter, is set as the unique Team identifier as well as the External ID of the imported ownership team.
  The mail parameter is set as the Email of the imported ownership team.
2. Select Entra ID groups as the Source of data on the Input tab.
3. Set Data containing the teams to import to {{ result("get_groups_1") }}—this uses the result of get_groups as the input for import_teams.
4. Select import preferences.
  
  Team import from Entra ID cannot be reversed. However, you can selectively import as well as protect changes to previously imported information when you choose one of the following.
  - If you've already imported teams from Entra ID, you can opt to Import new teams and skip existing teams. This option ensures that for the team IDs being imported, any team information already stored in Dynatrace is not overwritten. This option allows for team maintenance and scheduled runs of team import.
    
    This option is useful when you've previously imported teams and then modified the imported information in Dynatrace. In such cases, Dynatrace, not Entra ID, is the source of truth about your existing ownership teams, and you don't want subsequent runs of import_teams to overwrite your existing information.
  - If you want to import teams from Entra ID from scratch, select Import new teams and overwrite existing teams. For the team IDs being imported, this option overwrites any team information that already exists in Dynatrace.
JSON

import_teams enables you to import ownership team information that was previously generated as a JSON array by the run_javascript action within the same workflow. This approach enables you to retrieve team information from any third-party database in the structured format specified in the ownership configuration JSON schema (builtin:ownership.config) that Dynatrace provides.
1. Make sure that the run_javascript action precedes import_teams within the same workflow. We recommend that import_teams should immediately follow run_javascript. The result of run_javascript should be a JSON array that import_teams can consume.
2. In import_teams, select JSON in Ownership schema as the Source of data on the Input tab.
3. Set Data containing the teams to import to {{ result("run_javascript_1") }}—this is the result of run_javascript.
4. Select import preferences.
  
  Team import from JSON cannot be reversed. However, you can selectively import as well as protect changes to previously imported information when you choose one of the following.
  - Import new teams and skip existing teams ensures that for the team IDs being imported, any team information already stored in Dynatrace is not overwritten. This option allows for team maintenance and scheduled runs of team import.
    
    This option is useful when you've previously imported teams and then modified the imported information in Dynatrace. In such cases, you don't want subsequent runs of import_teams to overwrite your existing information.
  - To import teams from scratch, select Import new teams and overwrite existing teams. For the team IDs being imported, this option overwrites any team information that already exists in Dynatrace.

`get_owners`

This action assumes that you have set up ownership teams in Dynatrace and assigned them to monitored entities.

get_owners enables you to retrieve the associated ownership teams included in the metadata of specified entities.

This action takes an entity ID as input but can also infer the entity ID based on prior workflow logic.

You can optionally filter for teams based on responsibilities contained in team definitions (Filter by responsibility).

Filter owners

`get_contact_details` deprecated

This workflow action has been deprecated as of Ownership app version 1.4.0, and we don't recommend using it anymore. As you can now get all contact details, such as email addresses and Slack channels, in the results of the get_owners action, get_contact_details is no longer required.

This action assumes that you have set up ownership teams in Dynatrace and assigned them to monitored entities.

get_contact_details enables you to easily extract team contact details such as an email address or Slack channel.

This action can only come after get_owners in a workflow and takes the output of get_owners as its input ({{result("get_owners")}}). You can optionally filter for the specific type of contact information to retrieve (Filter by contact type).

Filter contact details

Automation Workflow Creator

Using the Ownership app is best exemplified by the Send logs to the owner of an entity tutorial in the Automation Workflow Creator app. You can save the tutorials in Automation Workflow Creator as notebooks, enabling you to view detailed instructions and run code snippets for sample workflows.

You can use Automation Workflow Creator to familiarize yourself with using prebuilt ownership actions in Workflows . Read more about Automation Workflow Creator in Dynatrace Developer.

In Dynatrace Hub , search for and open Automation Workflow Creator.
Scroll to the Send logs to the owner of an entity sample and select Choose workflow.
Save the tutorial to a new or existing notebook and select Add.

Your detailed tutorial is now available in Notebooks with detailed instructions, code samples that you can run, and links to a sample workflow.
Scroll and select the link to the sample workflow Automation Samples: Targeted Notifications that you can modify to suit your purposes.

Tutorial steps and sample workflow

This section provides context for and walks you through the Ownership tutorial and sample workflow set up above. The tutorial is saved in Notebooks while the sample workflow is saved in Workflows .

Step 1: Assign owners to a host.

As a prerequisite, you need to have set up ownership and assigned a team to a host in your environment. Read more on the available methods in Assign ownership teams to monitored entities. Note that you can apply a tag for ownership directly on the host overview page—select Owners at the top of the page and then select Add Ownership tag.
Step 2: Simulate a host event.

As an aid to the tutorial, this step simulates a host event of type Custom info; in an actual scenario, the host would experience an event or problem that triggers a workflow.

In the sample code provided, paste the host ID as shown below and select Run code. You can find the host ID in the URL of the host overview page.

You can see the event on the Events card of the host overview page.
Step 3: Fetch events; set up a workflow event trigger.

Step 3 of the tutorial takes the host ID as input to execute a DQL query that fetches host events of the CUSTOM_INFO type.

This corresponds to the first task in the Automation Samples: Targeted Notifications sample workflow, which sets up an event-based trigger for the workflow. Insert the host ID as shown and select Query events. The image below shows task output and details for the most recent event.
Step 4: Fetch host logs.

This tutorial step corresponds to the second task of the sample workflow, in which the get_logs action fetches the last 10 logs for the host. You need to provide the host ID to run the sample code in the tutorial. However, the workflow uses the code {{ event()["dt.entity.host"] }} to fetch logs for the host already defined in the workflow trigger.
Step 5: Fetch host ownership information (get_owners and get_contact details actions).

This tutorial step explains the get_owners and get_contact_details actions in the Automation Samples: Targeted Notifications sample workflow.

get_owners requires an entity ID as input to fetch associated ownership team information. However, within the sample workflow, get_owners uses the code {{ event()["dt.entity.host"] }} to fetch the teams for the host already defined in the workflow trigger.

get_contact_details uses {{result("get_owners")}} to take the output of get_owners as input to fetch team contact information.

Insert a separate get_contact_details action for each type of contact information you want to retrieve, for example, one each for Slack and Jira information.
Step 6: Run the sample workflow.

Before you select Run for your saved sample workflow, execute Step 2 of the tutorial a few times to simulate host events.

When you have executed your workflow, successful tasks are highlighted in green. Select each ownership action in the execution view to check its output.

get_owners returns team information in JSON format on the Result tab.

get_contact_details returns the team's Slack contact information on the Result tab.
Step 7: Set up a Slack action for targeted notifications.

You can extend the sample workflow by integrating with Slack for Workflows to send targeted notifications. Likewise, if you extract Jira contact information for the ownership team, you can integrate with Jira for Workflows for issue creation.