From c5c4adad8bc58b32600c456bd2231256c86165d1 Mon Sep 17 00:00:00 2001 From: qxz15oi Date: Wed, 31 Mar 2021 13:58:59 +0200 Subject: [PATCH] guidelines / templates redefined --- README - Full.md | 93 +++++++++++++-------------------------------- README - Testing.md | 41 ++++++++++++++++++++ 2 files changed, 67 insertions(+), 67 deletions(-) create mode 100644 README - Testing.md diff --git a/README - Full.md b/README - Full.md index 5d226928..c2729caf 100644 --- a/README - Full.md +++ b/README - Full.md @@ -8,44 +8,50 @@ To monitor your application with Dynatrace, please follow these steps: -1. Make sure you have access to Dynatrace. If not, follow this [link](https://atc.bmwgroup.net/bitbucket/projects/OPAPM/repos/cd_e2e_monitoring_config/browse/onboarding/CD_newComponentTag/custom-service-java/README.md) -2. Clone repository in your local machine: +1. Make sure you have access to Dynatrace. If not, follow this [link](https://atc.bmwgroup.net/confluence/display/OPAPM/User+Guide+-+Access+to+new+Dynatrace+Solution) +2. Clone this repository in your local machine: - `git clone https://atc.bmwgroup.net/bitbucket/scm/opapm/cd_e2e_monitoring_config.git` + `git clone https://atc.bmwgroup.net/bitbucket/scm/opapm/cd_e2e_monitoring_config.git` -4. Create branch using your Component/Application name with the following format: +4. Create a branch using your Component/Application name with the following format: - `git checkout -b CD_ApplicationName` + `git checkout -b CD_` -**What value should i use for ApplicationName?** -Previously to the restart of your application to let the OneAgent collect the traces, one of the steps within the implementation checklist is to set up a variable called DT_CUSTOM_PROP. Please use the same value for the ApplicationName. - -5. Execute the script passing as parameters, again, the ApplicationName: + **What value should i use for ?** + - Azure Runtime: i.e. for vehicle-composite-service you need to get [this](https://code.connected.bmw/runtime/tf-cluster-apps/blob/master/euprd/apps/vehicle-composite-service.tf#L8) value. + - Orbit: coming soon! + - Openshift: coming soon! + +5. Execute the script passing as parameters, again, the : - `./onboard.sh CD_ApplicationName ApplicationName` + `./onboard.sh CD_ ` 6. (optional) Configure Notification System - Dynatrace AI automatically detects anomalies in your applications and generate problems, visible within the UI. Dynatrace offers several out-of-the-box integrations with problem notification systems such as Email, MS Teams and ITSM. - - Notification system is not configured by default. If you want to enable it for your application please follow this [link](link). + - Notification systems are not configured by default. If you want to enable them for your application, please follow this [link](https://atc.bmwgroup.net/bitbucket/projects/OPAPM/repos/cd_e2e_monitoring_config/browse/onboarding/CD_newComponentTag/notification/README.md). 7. (optional) Add databases to Management Zone - The script described in step 5 will create the configuration for all entities related to your application (Host, Processes, Services) but not the databases. - To add your databases into Dynatrace you need to add an extra rule to the [Component.json](https://atc.bmwgroup.net/bitbucket/projects/OPAPM/repos/cd_e2e_monitoring_config/browse/BMW-Dynatrace-config/00_Global-Config/auto-tag/Component.json) file. You can use [this](link) example to understand exactly what you have to do. 8. Commit and pull request to merge the branch to the master: - `git add ` - `git commit -m "ApplicationName configuration changes"` - `git push -u origin ` + ``` + git add + git commit -m " configuration changes" + git push -u origin + ``` ### Results -Once the pull request is approved and **BMW Monaco** executes, all the configuration created in the previous steps will be visible in Dynatrace: +**Important** +- Configuration changes (like in dashboards, alerting profiles) must be done via a pull request. Changing a dashboard just in the environment, will cause that it will be overwritten by Monaco. +- Once the pull request is approved and **BMW Monaco** executes, all the configuration created in the previous steps will be visible in Dynatrace: #### Primary Configuration - *Management Zone* - Used to filter entities. - - Can be used to navigate the environment, filtering in dashboards and alerting profiles. + - Can be used to navigate the environment, filtering within dashboards and alerting profiles. - You can use the generated MZ clicking on the filter at the top-right corner within the Dynatrace UI. - Learn how to configure/improve your Management Zone [here](link) ([Do i need to configure it?](link)) @@ -100,54 +106,7 @@ The following configuration items are not set up by default. Learn the value tha **Recommended** -- Participate in one of the Dynatrace trainings to understand - - What kind of changes in the configuration are possible and how it's going to improve monitoring. - - Hands on in how to work with Monaco - - How to use Dynatrace in the most efficient. - -**Important** -- Changes (in dashboards, alerting profiles or any type of configuration) must be done via a pull request. Changing a dashboard just in the environment, will cause that it will be overwritten by Monaco. - -If you have any problems in the steps mentioned above, please contact opapm@bmw.de - -## (Dynatrace Admins) Testing - -This guide contain the steps to set up monaco and automatically onboard and application called "ABC" under the MZ "CD_ABC" -1. Clone repository in your local machine. -2. Define environment variables for the environment.yaml file. -i.e. -*export xxu26128_TOKEN= Dynatrace API token* -Do the same for the rest of the environments. Follow [this](https://www.dynatrace.com/support/help/shortlink/api-authentication#generate-a-token) link to learn how to generate a token in Dynatrace. -3. *mv bin/monaco /usr/bin* -4. Execute the onboard.sh script with the following parameters: -*./onboard.sh CD_ ApplicationName* -*./onboard.sh CD_ABC ABC* -5. To remove all CD_ABC configuration: - 1. Uncomment CD_ABC lines from delete.yaml. - 2. Execute monaco again to apply changes from delete.yaml: *monaco deploy -e="environment.yaml" -p="CD_ABC" BMW-Dynatrace-config/* - 3. Remove CD_ABC configuration folder - -### Results -- CD_ABC Management Zone created containing all entities with ABC tag. -- PROD/E2E/INT Dashboards for CD_ABC components. -- PROD/E2E/INT Alerting Profiles for CD_ABC components. - -### Update configuration -1. Execute the following command: -*monaco deploy -e="environment.yaml" -p="00_Global-Config" BMW-Dynatrace-config/* - - Under -p you can select the configuration you want to update - -### Debugging -- set environment variable MONACO_REQUEST_LOG=mylogfile.log to see what exactly gets sent to DT - -### Download configuration -Configuration has been downloaded and set up under BMW-Dynatrace-config. It's not necessary to be downloaded again. -To download the existing configuration for all tenants, execute the following commands: - 1. cd downloaded-config - 2. *monaco download -e='../environment.yaml'* -To download the existing configuration for a specific tenant, execute the following commands: - 1. cd downloaded-config - 2. *monaco download -e='../environment.yaml' -s EMEA-Prod* - -### Automatic config environment variables -- source ./exports.sh \ No newline at end of file +- Participate in one of the Dynatrace trainings to understand: + - How to use Dynatrace in the most efficient way. + - What kind of changes in the configuration are possible and how will improve monitoring. + - Hands on in how to work with Monaco (Dynatrace Configuration as Code) \ No newline at end of file diff --git a/README - Testing.md b/README - Testing.md new file mode 100644 index 00000000..8fd5878c --- /dev/null +++ b/README - Testing.md @@ -0,0 +1,41 @@ +## (Dynatrace Admins) Testing + +This guide contain the steps to set up monaco and automatically onboard and application called "ABC" under the MZ "CD_ABC" +1. Clone repository in your local machine. +2. Define environment variables for the environment.yaml file. +i.e. +*export xxu26128_TOKEN= Dynatrace API token* +Do the same for the rest of the environments. Follow [this](https://www.dynatrace.com/support/help/shortlink/api-authentication#generate-a-token) link to learn how to generate a token in Dynatrace. +3. *mv bin/monaco /usr/bin* +4. Execute the onboard.sh script with the following parameters: +*./onboard.sh CD_ ApplicationName* +*./onboard.sh CD_ABC ABC* +5. To remove all CD_ABC configuration: + 1. Uncomment CD_ABC lines from delete.yaml. + 2. Execute monaco again to apply changes from delete.yaml: *monaco deploy -e="environment.yaml" -p="CD_ABC" BMW-Dynatrace-config/* + 3. Remove CD_ABC configuration folder + +### Results +- CD_ABC Management Zone created containing all entities with ABC tag. +- PROD/E2E/INT Dashboards for CD_ABC components. +- PROD/E2E/INT Alerting Profiles for CD_ABC components. + +### Update configuration +1. Execute the following command: +*monaco deploy -e="environment.yaml" -p="00_Global-Config" BMW-Dynatrace-config/* + - Under -p you can select the configuration you want to update + +### Debugging +- set environment variable MONACO_REQUEST_LOG=mylogfile.log to see what exactly gets sent to DT + +### Download configuration +Configuration has been downloaded and set up under BMW-Dynatrace-config. It's not necessary to be downloaded again. +To download the existing configuration for all tenants, execute the following commands: + 1. cd downloaded-config + 2. *monaco download -e='../environment.yaml'* +To download the existing configuration for a specific tenant, execute the following commands: + 1. cd downloaded-config + 2. *monaco download -e='../environment.yaml' -s EMEA-Prod* + +### Automatic config environment variables +- source ./exports.sh \ No newline at end of file