Merge pull request #4 from l0k0ms/patch-1

Readme update

Author: achntrl

azure/activity_logs_monitoring/README.md

@@ -1,38 +1,41 @@
-# Azure functions (Private Beta)
+# Datadog-Azure function (Private Beta)
 
-Function used to forward Azure logs, including Activity and Diagnostic logs from EventHub.
-This is currently in Private beta, instructions and code are subject to modifications.
+The Datadog-Azure function is used to forward Azure logs to Datadog, including Activity and Diagnostic logs from EventHub.
 
-# Quick Start
+**This is currently in Private beta, instructions and code are subject to modifications.**
 
-The provided NodeJs script must be deployed into your Azure Functions service. We will explain how in this step-by-step tutorial.
+## Quick Start
 
-## 1. Create a new EventHub triggered function
+The provided Node.js script must be deployed into your Azure Functions service. Follow the tutorial below to learn how to do so:
 
-- Expand your function app and click the + button next to Functions. If this is the first function in your function app, select Custom function. This displays the complete set of function templates.
-- In the search field type `Event Hub` and choose `Event Hub Trigger`
-- Select the `Javascript` language in the right menu
-- Enter a name for the function
-- Add the wanted `Event Hub connection` or create a new one if you haven't have one already
-- Select the `Event Hub consumer group` and the `Event Hub Name` you want to pull logs from
+### 1. Create a new EventHub triggered function
 
-## 2. Provide the code
+- Expand your function application and click the `+` button next to `Functions`. If this is the first function in your function application, select `Custom function`. This displays the complete set of function templates.
+- In the search field type `Event Hub` and choose `Event Hub Trigger`.
+- Select the `Javascript` language in the right menu.
+- Enter a name for the function.
+- Add the wanted `Event Hub connection` or create a new one if you haven't have one already.
+- Select the `Event Hub consumer group` and the `Event Hub Name` you want to pull logs from.
 
-- Copy paste the code of the function
-- In the `Integrate` part, make sure the `Event Hub Cardinality` is set to `Many`
+### 2. Provide the code
+
+- Copy paste the code of the [Datadog-Azure function](./index.js)
+- In the `Integrate` part, `Event Hub Cardinality` must be set to `Many`.
 
 ## Parameters
 
 - **API KEY**:
 
-There are 2 possibilities to set your Datadog's API key (available in your Datadog platform):
+There are 2 possibilities to set your [Datadog's API key](https://app.datadoghq.com/account/settings#api):
 
-1. Replace `<your-api-key>` in the code with the API Key value
+1. Replace `<DATADOG_API_KEY>` in the code with your API Key value.
 2. Set the value through the `DD_API_KEY` environment variable
 
 - **Custom Tags**:
 
-You have two options to add custom tags to your logs (tags must be a comma-separated list of strings):
+You have two options to add custom tags to your logs:
 
 - Manually by editing the function code to add the tag list to the variable `DD_TAGS`
 - Automatically with the `DD_TAGS` environment variable
+
+Learn more about Datadog tagging in our main [Tagging documentation](https://docs.datadoghq.com/tagging/).

azure/activity_logs_monitoring/index.js

@@ -4,7 +4,7 @@
 // Copyright 2018 Datadog, Inc.
 
 var tls = require('tls');
-var DD_API_KEY = process.env.DD_API_KEY || '<your-api-key>';
+var DD_API_KEY = process.env.DD_API_KEY || '<DATADOG_API_KEY>';
 var DD_URL = process.env.DD_URL || 'lambda-intake.logs.datadoghq.com';
 var DD_TAGS = process.env.DD_TAGS || '';
 var DD_PORT = process.env.DD_PORT || 10516;