clever-tools 2.8.1 → 2.9.0

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # clever-tools changelog
 
-## 2.8.1 (2021-01-10)
+## 2.9.0 (2022-01-12)
+
+* Add NewRelic support in `clever drains`
+
+## 2.8.1 (2022-01-10)
 
 * Fix `colors` to `1.4.0`
 

package/README.md

@@ -320,6 +320,7 @@ Where `DRAIN-TYPE` is one of:
 - `HTTP`: for TCP syslog endpoint (note that this endpoint has optional username/passwordparameters as HTTP Basic Authentication);
 - `ElasticSearch`: for ElasticSearch endpoint (note that this endpoint requires username/password parameters as HTTP Basic Authentication);
 - `DatadogHTTP`: for Datadog endpoint (note that this endpoint needs your Datadog API Key).
+- `NewRelicHTTP`: for NewRelic endpoint (note that this endpoint needs your NewRelic API Key).
 
 #### ElasticSearch logs drains
 
@@ -337,6 +338,16 @@ clever drain create DatadogHTTP "https://http-intake.logs.datadoghq.com/v1/input
 
 Please note that the `host` query parameter is not mandatory: in the Datadog pipeline configuration, you can map `@source_host` which is the host provided by Clever Cloud in logs as `host` property.
 
+#### NewRelic logs drains
+
+NewRelic has two zones, EU and US. An account on one zone is not available on the other, make sure to target the good EU or US intake endpoint.
+
+To create a [NewRelic](https://docs.newrelic.com/docs/logs/log-api/introduction-log-api/) drain, you just need to use:
+
+```sh
+clever drain create NewRelicHTTP "https://log-api.eu.newrelic.com/log/v1" --api-key <API_KEY>
+```
+
 ### Display help
 
 You can display help about each command with `clever help`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clever-tools",
-  "version": "2.8.1",
+  "version": "2.9.0",
   "description": "Command Line Interface for Clever Cloud.",
   "main": "bin/clever.js",
   "keywords": [

package/src/models/drain.js

@@ -8,12 +8,13 @@ const DRAIN_TYPES = [
   { id: 'HTTP', credentials: 'OPTIONAL' },
   { id: 'ElasticSearch', credentials: 'MANDATORY' },
   { id: 'DatadogHTTP' },
+  { id: 'NewRelicHTTP', apiKey: 'MANDATORY' },
 ];
 
 function createDrainBody (appId, drainTargetURL, drainTargetType, drainTargetCredentials, drainTargetConfig) {
 
-  if (!authorizeDrainCreation(drainTargetType, drainTargetCredentials)) {
-    throw new Error("Credentials are: optional for HTTP, mandatory for ElasticSearch and TCPSyslog/UDPSyslog don't need them.");
+  if (!authorizeDrainCreation(drainTargetType, drainTargetCredentials, drainTargetConfig)) {
+    throw new Error("Credentials are: optional for HTTP, mandatory for ElasticSearch, NewRelicHTTP and TCPSyslog/UDPSyslog don't need them.");
   }
 
   const body = {
@@ -26,20 +27,37 @@ function createDrainBody (appId, drainTargetURL, drainTargetType, drainTargetCre
       password: drainTargetCredentials.password || '',
     };
   }
+  if (keyExist(drainTargetConfig)) {
+    body.APIKey = drainTargetConfig.apiKey;
+  }
   return body;
 }
 
-function authorizeDrainCreation (drainTargetType, drainTargetCredentials) {
+function authorizeDrainCreation (drainTargetType, drainTargetCredentials, drainTargetConfig) {
   if (drainTypeExists(drainTargetType)) {
     // retrieve creds for drain type ('mandatory', 'optional', undefined)
-    const status = credentialsStatus(drainTargetType).credentials;
-    if (status === 'MANDATORY') {
+    const credStatus = credentialsStatus(drainTargetType).credentials;
+    const keyStatus = credentialsStatus(drainTargetType).apiKey;
+
+    if (credStatus === 'MANDATORY') {
       return credentialsExist(drainTargetCredentials);
     }
-    if (status === 'OPTIONAL') {
+    if (credStatus === 'OPTIONAL') {
+      return true;
+    }
+    if (!credStatus && !keyStatus) {
+      return credentialsEmpty(drainTargetCredentials);
+    }
+
+    if (keyStatus === 'MANDATORY') {
+      return keyExist(drainTargetConfig);
+    }
+    if (keyStatus === 'OPTIONAL') {
       return true;
     }
-    return credentialsEmpty(drainTargetCredentials);
+    if (!keyStatus) {
+      return keyEmpty(drainTargetConfig);
+    }
   }
 }
 
@@ -59,6 +77,14 @@ function credentialsEmpty ({ username, password }) {
   return username == null && password == null;
 }
 
+function keyExist ({ apiKey }) {
+  return apiKey != null;
+}
+
+function keyEmpty ({ apiKey }) {
+  return apiKey == null;
+}
+
 function listDrainTypes () {
   return autocomplete.words(DRAIN_TYPES.map((type) => type.id));
 }