https://github.com/martezr/morpheus-datadog-instance-tab-plugin
Morpheus custom instance tab for DataDog
https://github.com/martezr/morpheus-datadog-instance-tab-plugin
morpheus
Last synced: 5 months ago
JSON representation
Morpheus custom instance tab for DataDog
- Host: GitHub
- URL: https://github.com/martezr/morpheus-datadog-instance-tab-plugin
- Owner: martezr
- Created: 2021-10-18T16:34:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T14:12:27.000Z (about 2 years ago)
- Last Synced: 2025-03-13T02:37:31.599Z (over 1 year ago)
- Topics: morpheus
- Language: Groovy
- Homepage:
- Size: 1.19 MB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# DataDog Integration
The DataDog integration plugin integrates with the DataDog monitoring solution to bring contextual workload data from DataDog into the Morpheus UI. The plugin adds a new DataDog tab to Morpheus instances that includes monitoring details pulled from DataDog.
## Requirements
The following requirements must be met prior to using the DataDog plugin:
* A DataDog account (https://www.datadoghq.com/).
* An API key and Application key that will be used by the plugin to perform API calls to the DataDog API (https://docs.datadoghq.com/account_management/api-app-keys/).
* A compatible Morpheus platform version. The Morpheus platform version must be equal to or higher than the version specified on the plugin.
## Installation
Once the plugin file is downloaded, browse to the Administration -> Integrations -> Plugins section in the Morpheus UI. Click the Upload File button to select your plugin and upload it. The plugin should now be loaded into the environment for use.
## Configuration
With the plugin installed, there are a few configuration steps required before you are able to use the plugin.
### Plugin Settings
The plugin supports dynamic configuration via the plugin settings which are accessed by clicking on the pencil next to the plugin.
The following settings are available for the DataDog plugin:
|Setting|Description|Required|Default|
|---|---|---|---|
| API Endpoint | The API endpoint used for fetching instance data | No | Public (datadoghq.com) |
| API Key |The generated DataDog API key used to authenticate to the DataDog REST API | Yes |n/a |
| Application Key | The generated DataDog Application key used to authenticate to the DataDog REST API | Yes |n/a |
| [Plugin Customization](#custom-settings) |The plugin customization field supports a custom YAML payload for configuring additional plugin settings.| No |n/a|
| Environments | This toggles the visibility of the tab based upon the Morpheus environment the instance is in. Multiple environments are supported by adding multiple comma separated environments in the text box.| No| any|
| Groups | This toggles the visibility of the tab based upon the Morpheus group the instance is in. Multiple groups are supported by adding multiple comma separated groups in the text box.| No|any |
| Tags | This toggles the visibility of the tab based upon the tag(s) assigned to the instance. The tag key is what is used for the evaluation. Multiple tags are supported by adding multiple comma separated tags in the text box.|No| datadog |
| Labels | This toggles the visibility of the tab based upon the label(s) assigned to the instance. Multiple labels are supported by adding multiple comma separated labels in the text box.|No| any |
#### Custom Settings
The plugin supports additional customization through the `PLUGIN CUSTOMIZATION` text field. A YAML payload is expected.
**Query DataDog Instance Using an Environment Variable**
Configure the plugin to search for the instance in DataDog using the name provided in the value of the `DATADOG_INSTANCE_NAME` environment variable.
```
---
instanceName:
property: evar
value: DATADOG_INSTANCE_NAME
```
**Query DataDog Instance Using a Tag**
Configure the plugin to search for the instance in DataDog using the name provided in the value of the `datadogName` tag.
```
---
instanceName:
property: tag
value: datadogName
```
**Morpheus Subtenant Configuration**
DataDog supports multitenancy or multiple-organization accounts (https://docs.datadoghq.com/account_management/multi_organization/) to enable large organizations or service providers to effectively manage multiple subaccounts. This section of the plugin configuration supports use cases where additional configuration needs to be added to Morpheus subtenants in order to align with the use of a DataDog organization per Morpheus subtenant.
```
---
tenantMetadata:
- name: "morpheus"
dataDogSubdomain: morpheus
- name: "customer A"
dataDogSubdomain: test
- name: "customer B"
dataDogSubdomain: testB
```
### Permissions
The DataDog plugin adds a new RBAC permission to the Morpheus platform.
**Permission Name**
```
DataDog Instance Tab
```
The permissions supports FULL and NONE access types for which aligns to whether the user sees the instance tab or not.
## Usage
Once the plugin has been installed and configured, any instance in the appropriate group, environment and with the required tags will display the DataDog tab on the instance page.