diff --git a/README.md b/README.md index 0bdbd01..2354098 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,20 @@ The Dynatrace API examples demonstrate how to access various parts of Dynatrace, such as timeseries, problem feed and infrastructure topology as an API consumer. -### Dynatrace API documentation +## Dynatrace API documentation The full Dynatrace API documentation can be found here: https://help.dynatrace.com/api-documentation/v1/ -####`API key` -The API key for your Dynatrace tenant. You can generate a key by following these steps +## API key +In order to use the Dynatrace API, you need an API key for your Dynatrace tenant. You can generate a key by following these steps -1. go to your Dynatrace environment: https://{tenant}.live.dynatrace.com +1. Go to your Dynatrace environment: https://{tenant}.live.dynatrace.com 2. Expand the side-bar menu on the left side of the screen and go to **Settings** and then **Integration** 3. Choose the **Dynatrace API** section 4. Click on **Generate token** to create a new API key 5. Enter a description label and submit the request 6. Expand the created key via clicking on the "Edit"-label, copy the token and use it in your Dynatrace API examples -##License +## License This module is provided under BSD-3-Clause license. Please check out the details in the LICENSE.txt diff --git a/cloudwatchbridge/README.md b/cloudwatchbridge/README.md index db53f13..426dcc3 100644 --- a/cloudwatchbridge/README.md +++ b/cloudwatchbridge/README.md @@ -10,20 +10,20 @@ https://help.dynatrace.com/api-documentation/v1/ 1. Install the [Amazon CloudWatch Command Line Interface](http://docs.aws.amazon.com/AmazonCloudWatch/latest/cli/SetupCLI.html) 2. Setup and authenticate your Amazon CloudWatch Command Line Interface -3. Create a Dynatrace API key +3. Create a Dynatrace API key (see below) 4. Enter your Dynatrace environment id and your API key within the dt_cw_bridge.py script 5. Configure valid timeseries ids, aggregation types and entities within the dt_cw_bridge.py script -6. Run the script by typing **python dt_cw_bridge.py** +6. Run the script by typing `python dt_cw_bridge.py` -####`API key` -The API key for your Dynatrace tenant. You can generate a key by following these steps +## API key +In order to use the Dynatrace API, you need an API key for your Dynatrace tenant. You can generate a key by following these steps -1. go to your Dynatrace environment: https://{tenant}.live.dynatrace.com -2. Click the burger menu in the right upper corner and select **Integration** -3. You will see the "Dynatrace API" section; -4. Enter a description label and click on **Generate** -5. copy it and use it in your Dynatrace API examples +1. Go to your Dynatrace environment: https://{tenant}.live.dynatrace.com +2. Expand the side-bar menu on the left side of the screen and go to **Settings** and then **Integration** +3. Choose the **Dynatrace API** section +4. Click on **Generate token** to create a new API key +5. Enter a description label and submit the request +6. Expand the created key via clicking on the "Edit"-label, copy the token and use it in your Dynatrace API examples -##License +## License This module is provided under BSD-3-Clause license. Please check out the details in the LICENSE.txt - diff --git a/cloudwatchbridge/dt_cw_bridge.py b/cloudwatchbridge/dt_cw_bridge.py index 3faa136..da2d91e 100644 --- a/cloudwatchbridge/dt_cw_bridge.py +++ b/cloudwatchbridge/dt_cw_bridge.py @@ -1,5 +1,5 @@ # -# Script for transfering Dynatrace timeseries into AWS CloudWatch. +# Script for transferring Dynatrace timeseries into AWS CloudWatch. # import requests, datetime, time, sched, subprocess, shlex @@ -50,12 +50,3 @@ def export_metric(name): print('Error ' + r); scheduler.enter(1, 1, export_metric, ('first',)) scheduler.run() - - - - - - - - - diff --git a/custom-device-metrics-F5-example/README.md b/custom-device-metrics-F5-example/README.md index 5872343..719c1c6 100644 --- a/custom-device-metrics-F5-example/README.md +++ b/custom-device-metrics-F5-example/README.md @@ -1,4 +1,3 @@ - ## Overview The custom metric and device example demonstrates how to use the Dynatrace API to define new metrics and @@ -7,8 +6,7 @@ Within this tiny example a F5 firewall metric is simulated with two metric dimen First the timeseries metrics are registered, then the device metadata along with the metric values is sent by using a scheduled job. - -### Prerequisites +## Prerequisites The full Dynatrace API documentation can be found here: https://help.dynatrace.com/api-documentation/v1/ @@ -16,15 +14,15 @@ https://help.dynatrace.com/api-documentation/v1/ 1. Create a Dynatrace API key 4. Enter your Dynatrace environment id and your API key within the dt_auto_tag.py script -####`API key` -The API key for your Dynatrace tenant. You can generate a key by following these steps +## API key +In order to use the Dynatrace API, you need an API key for your Dynatrace tenant. You can generate a key by following these steps -1. go to your Dynatrace environment: https://{tenant}.live.dynatrace.com -2. Click the burger menu in the right upper corner and select **Integration** -3. You will see the "Dynatrace API" section; -4. Enter a description label and click on **Generate** -5. copy it and use it in your Dynatrace API examples +1. Go to your Dynatrace environment: https://{tenant}.live.dynatrace.com +2. Expand the side-bar menu on the left side of the screen and go to **Settings** and then **Integration** +3. Choose the **Dynatrace API** section +4. Click on **Generate token** to create a new API key +5. Enter a description label and submit the request +6. Expand the created key via clicking on the "Edit"-label, copy the token and use it in your Dynatrace API examples -##License +## License This module is provided under BSD-3-Clause license. Please check out the details in the LICENSE.txt - diff --git a/custom-device-metrics-F5-example/custom_device.py b/custom-device-metrics-F5-example/custom_device.py index 8cc7db0..448ce96 100644 --- a/custom-device-metrics-F5-example/custom_device.py +++ b/custom-device-metrics-F5-example/custom_device.py @@ -54,12 +54,3 @@ def print_event(name): print("START") scheduler.enter(1, 1, print_event, ('first',)) scheduler.run() - - - - - - - - - diff --git a/custom-device-metrics-Raspberry-example/README.md b/custom-device-metrics-Raspberry-example/README.md index 4390a8d..85d329a 100644 --- a/custom-device-metrics-Raspberry-example/README.md +++ b/custom-device-metrics-Raspberry-example/README.md @@ -8,24 +8,23 @@ into a Dynatrace environment. First the timeseries metrics are registered, then the device metadata along with the metric values is sent by using a scheduled job. - -### Prerequisites +## Prerequisites The full Dynatrace API documentation can be found here: https://help.dynatrace.com/api-documentation/v1/ -1. Create a Dynatrace API key +1. Create a Dynatrace API key (see below) 4. Enter your Dynatrace environment id and your API key within the dt_auto_tag.py script -####`API key` -The API key for your Dynatrace tenant. You can generate a key by following these steps +## API key +In order to use the Dynatrace API, you need an API key for your Dynatrace tenant. You can generate a key by following these steps -1. go to your Dynatrace environment: https://{tenant}.live.dynatrace.com -2. Click the burger menu in the right upper corner and select **Integration** -3. You will see the "Dynatrace API" section; -4. Enter a description label and click on **Generate** -5. copy it and use it in your Dynatrace API examples +1. Go to your Dynatrace environment: https://{tenant}.live.dynatrace.com +2. Expand the side-bar menu on the left side of the screen and go to **Settings** and then **Integration** +3. Choose the **Dynatrace API** section +4. Click on **Generate token** to create a new API key +5. Enter a description label and submit the request +6. Expand the created key via clicking on the "Edit"-label, copy the token and use it in your Dynatrace API examples -##License +## License This module is provided under BSD-3-Clause license. Please check out the details in the LICENSE.txt - diff --git a/custom-device-metrics-Raspberry-example/rasp.py b/custom-device-metrics-Raspberry-example/rasp.py index 0485e5d..1c36444 100644 --- a/custom-device-metrics-Raspberry-example/rasp.py +++ b/custom-device-metrics-Raspberry-example/rasp.py @@ -84,6 +84,6 @@ def print_event(name): print("START") # Within this example a Python scheduler is used to trigger a metric update every minute. # To ensure the reliable execution of the script in a real world scenario you could either use a cron job -# or to execture the script within a managed execution environment. +# or execute the script within a managed execution environment. scheduler.enter(1, 1, print_event, ('first',)) scheduler.run() \ No newline at end of file diff --git a/tagging/README.md b/tagging/README.md index cad1f52..7474ebb 100644 --- a/tagging/README.md +++ b/tagging/README.md @@ -4,7 +4,7 @@ The tagging example demonstrates how to automatically tag monitored components that contain a specific substring pattern within the display name. -### Prerequisites +## Prerequisites The full Dynatrace API documentation can be found here: https://help.dynatrace.com/api-documentation/v1/ @@ -12,17 +12,17 @@ https://help.dynatrace.com/api-documentation/v1/ 1. Create a Dynatrace API key 4. Enter your Dynatrace environment id and your API key within the dt_auto_tag.py script 5. Configure a name string pattern and some tags -6. Run the script by typing **python dt_auto_tag.py** +6. Run the script by typing `python dt_auto_tag.py` -####`API key` -The API key for your Dynatrace tenant. You can generate a key by following these steps +## API key +In order to use the Dynatrace API, you need an API key for your Dynatrace tenant. You can generate a key by following these steps -1. go to your Dynatrace environment: https://{tenant}.live.dynatrace.com -2. Click the burger menu in the right upper corner and select **Integration** -3. You will see the "Dynatrace API" section; -4. Enter a description label and click on **Generate** -5. copy it and use it in your Dynatrace API examples +1. Go to your Dynatrace environment: https://{tenant}.live.dynatrace.com +2. Expand the side-bar menu on the left side of the screen and go to **Settings** and then **Integration** +3. Choose the **Dynatrace API** section +4. Click on **Generate token** to create a new API key +5. Enter a description label and submit the request +6. Expand the created key via clicking on the "Edit"-label, copy the token and use it in your Dynatrace API examples -##License +## License This module is provided under BSD-3-Clause license. Please check out the details in the LICENSE.txt - diff --git a/timeseries-examples/Node.js/README.md b/timeseries-examples/Node.js/README.md index b4683fd..0e6281b 100644 --- a/timeseries-examples/Node.js/README.md +++ b/timeseries-examples/Node.js/README.md @@ -6,19 +6,20 @@ Mind that a Node.js service wrapper is used to cope with the Browsers security r from the same origin. The service wrapper also hides the secret API token for accessing the Dynatrace tenant data instead of exposing it within the JavaScript. -### Dynatrace data export API documentation +## Dynatrace data export API documentation The full API documentation can be found here: https://help.dynatrace.com/api-documentation/v1/timeseries -####`API key` -The API key for your Dynatrace tenant. You can generate a key by following these steps +## API key +In order to use the Dynatrace API, you need an API key for your Dynatrace tenant. You can generate a key by following these steps -1. go to your Dynatrace environment: https://{tenant}.live.dynatrace.com -2. Click the burger menu in the right upper corner and select **Integration** -3. You will see the "Dynatrace API" section; -4. Enter a description label and click on **Generate** -5. copy it and use it in your data export API examples +1. Go to your Dynatrace environment: https://{tenant}.live.dynatrace.com +2. Expand the side-bar menu on the left side of the screen and go to **Settings** and then **Integration** +3. Choose the **Dynatrace API** section +4. Click on **Generate token** to create a new API key +5. Enter a description label and submit the request +6. Expand the created key via clicking on the "Edit"-label, copy the token and use it in your Dynatrace API examples -##License +## License This module is provided under BSD-3-Clause license. Please check out the details in the LICENSE.txt diff --git a/topology-smartscape/README.md b/topology-smartscape/README.md index 7204c70..c7c8ee5 100644 --- a/topology-smartscape/README.md +++ b/topology-smartscape/README.md @@ -1,4 +1,4 @@ -This example shows how to use the Dynatrace Topology and Smartscape API in order to create a service map. +This example shows how to use the Dynatrace Topology and Smartscape API to create a service map. The example calls the topology REST endpoint and fetches the list of monitored services along with their attributes and call relations. Sigma.js is then used to visualize this service map directly within your browser.