search something relevant into a Service/subservice in Splunk

ChangeLog

@@ -1,6 +1,7 @@
 CHANGES
 =======
 
+ADD: search about something relevant in a Service/subservice into Splunk (#196)
 ADD: Allow subservices names with '-'
 ADD: anon passwords in debug logs
 ADD: extra check for getUserDetailsByAdmin to create response

DOCKER.md

@@ -46,6 +46,7 @@ As you can see there are several arguments to pass to orchestrator entry point i
    -cygnushost <value>
    -mailerhost <value>
    -ldaphost <value>
+   -splunkhost <value>
    -keystoneport <value>
    -keypassport <value>
    -orionport <value>
@@ -55,12 +56,15 @@ As you can see there are several arguments to pass to orchestrator entry point i
    -cygnusport <value>
    -ldapport <value>
    -mailerport <value>
+   -splunkport <value>
    -ldapbasedn <value>
    -maileruser <value>
    -mailerpasswd <value>
    -mailerfrom <value>
    -mailerto <value>
    -mongodburi <value>
+   -splunkuser <value>
+   -splunkpasswd <value>
 ```
 
 

Dockerfile

@@ -50,6 +50,13 @@ ENV MAILER_TO smtpto
 
 ENV MONGODB_URI localhost:27017
 
+ENV SPLUNK_HOST localhost
+ENV SPLUNK_PORT 8089
+ENV SPLUNK_PROTOCOL https
+ENV SPLUNK_USER splkuser
+ENV SPLUNK_PASSWORD splkpass
+
+
 ENV PEP_PASSWORD pep
 ENV IOTAGENT_PASSWORD iotagent
 
@@ -146,6 +153,14 @@ RUN \
              \"to\": \"'$MAILER_TO'\" \
 }/g' /opt/orchestrator/settings/dev.py  && \
 
+    sed -i ':a;N;$!ba;s/SPLUNK = {[A-Za-z0-9,=@.\-\/\"\n: ]*}/SPLUNK = { \
+             \"protocol\": \"'$SPLUNK_PROTOCOL'\", \
+             \"host\": \"'$SPLUNK_HOST'\", \
+             \"port\": \"'$SPLUNK_PORT'\", \
+             \"user\": \"'$SPLUNK_USER'\", \
+             \"password\": \"'$SPLUNK_PASSWORD'\" \
+}/g' /opt/orchestrator/settings/dev.py  && \
+
     sed -i ':a;N;$!ba;s/MONGODB = {[A-Za-z0-9,\/\"\n: ]*}/MONGODB = { \
              \"URI\": \"mongodb:\/\/'$MONGODB_URI'\" \
 }/g' /opt/orchestrator/settings/dev.py  && \
@@ -178,6 +193,11 @@ RUN \
     sed -i 's/MAILER_FROM=smtpuser/MAILER_FROM='$MAILER_FROM'/g' /opt/orchestrator/bin/orchestrator-entrypoint.sh && \
     sed -i 's/MAILER_TO=smtpuser/MAILER_TO='$MAILER_TO'/g' /opt/orchestrator/bin/orchestrator-entrypoint.sh && \
     sed -i 's/MONGODB_URI=localhost:27017/MONGODB_URI='$MONGODB_URI'/g' /opt/orchestrator/bin/orchestrator-entrypoint.sh && \
+    sed -i 's/SPLUNK_HOST=localhost/SPLUNK_HOST='$SPLUNK_HOST'/g' /opt/orchestrator/bin/orchestrator-entrypoint.sh && \
+    sed -i 's/SPLUNK_PORT=587/SPLUNK_PORT='$SPLUNK_PORT'/g' /opt/orchestrator/bin/orchestrator-entrypoint.sh && \
+    sed -i 's/SPLUNK_PROTOCOL=https/SPLUNK_PROTOCOL='$SPLUNK_PROTOCOL'/g' /opt/orchestrator/bin/orchestrator-entrypoint.sh && \
+    sed -i 's/[email protected]/SPLUNK_USER='$SPLUNK_USER'/g' /opt/orchestrator/bin/orchestrator-entrypoint.sh && \
+    sed -i 's/SPLUNK_PASSWORD=yourpassword/SPLUNK_PASSWORD='$SPLUNK_PASSWORD'/g' /opt/orchestrator/bin/orchestrator-entrypoint.sh && \
     # Put orchestrator version
     sed -i 's/ORC_version/'$ORCHESTRATOR_VERSION'/g' /opt/orchestrator/settings/common.py && \
     sed -i 's/\${project.version}/'$ORCHESTRATOR_VERSION'/g' /opt/orchestrator/orchestrator/core/banner.txt && \

README.md

@@ -26,6 +26,7 @@ Orchestrator is used to:
 - Activate / deactivate IoT Modules
 - Retrieve statistics and metrics about API usage
 - Create, List, Modify LDAP Users
+- Search for something relevant in a service (or subservice)
 
 Orchestrator is based mainly on:
 - Python 2.7 needed
@@ -41,6 +42,7 @@ Orchestrator relies on these other IoT parts:
 - OpenLDAP (optional)
 - Mailer (optional)
 - MongoDB (optional)
+- Splunk (optional)
 
 Some of these IoT parts are optional, this means that orchestrator can work without them but excluding the part of feature in which are involved. This way Keystone and Keypass are mandatory to deal with Orchestrator.
 

apiary.apib

@@ -875,9 +875,62 @@ In the cases where "serviceId" is part of URL "SERVICE_NAME" field at body can b
         }
 
 
+## Activate IoT Module in a Service [/v1.0/service/{serviceId}/module_activation/{iot_module}]
+
+### list activated IoT Modules [GET]
++ Parameters
+    + serviceId (required, `string`) ... Service Id
++ Request (application/json)
+            {
+                "SERVICE_NAME":"test_service",
+                "SERVICE_USER_NAME":"test_admin_service",
+                "SERVICE_USER_PASSWORD":"passwd",
+                "SERVICE_USER_TOKEN":"token",
+            }
++ Response 200 (application/json)
+    + Body
+      {
+         "activated_modules": [ {"name": "STH", "subscriptionid": "23423435", "alias": "HISTORIC"},
+                                {"name": "PERSEO", "subscriptionid": "34243434", "alias": "RULES"} ]
+      }
+
+### activate an IoT Module [POST]
++ Parameters
+    + serviceId (required, `string`) ... Service Id
+    + iot_module (optional, `string`) ... IOTModule
++ Request (application/json)
+            {
+                "SERVICE_NAME":"test_service",
+                "SERVICE_USER_NAME":"test_admin_service",
+                "SERVICE_USER_PASSWORD":"passwd",
+                "SERVICE_USER_TOKEN":"token",
+                "IOTMODULE":"STH"
+            }
+        Required: [ "iot_module/IOTMODULE" ]
++ Response 201 (application/json)
+    + Body
+      {
+         "subscriptionid": "23423435"
+      }
+
+### deactivate an IoT Module [DELETE]
++ Parameters
+    + serviceId (required, `string`) ... Service id
+    + iot_module (optional, `string`) ... IOTModule
++ Request (application/json)
+            {
+                "SERVICE_NAME":"test_service",
+                "SERVICE_USER_NAME":"test_admin_service",
+                "SERVICE_USER_PASSWORD":"passwd",
+                "SERVICE_USER_TOKEN":"token",
+                "IOTMODULE":"STH"
+            }
+        Required: [ "iot_module/IOTMODULE" ]
++ Response 204
+
 ## Activate IoT Module in a Sub-service of service [/v1.0/service/{serviceId}/subservice/{subserviceId}/module_activation/{iot_module}]
 
-### list activated IoT Modules [POST]
+### list activated IoT Modules [GET]
 + Parameters
     + serviceId (required, `string`) ... Service Id
     + subserviceId (required, `string`) ... SubService Id
@@ -1199,3 +1252,50 @@ The following metrics are collected by the component:
       {
          "details": "OK"
       }
+
+## Search something relevant about a Service in Splunk [/v1.0/service/{serviceId}/relevant/{component}]
+
+### Search something relevant about a Service [POST]
++ Parameters
+    + serviceId (required, `string`) ... Service Id
+    + COMPONENT (required, `string`) ... IoT component (cygnus-ngsi, Orchestrator, Orion, STH, PEPorion, PEPsth, PEPperseo, PEPiotagent, perseo-fe, perseo-core, IoTAgent)
+    + TRANSACTION_ID (optional, `string`) ... Transaction Id
+    + CORRELATOR_ID (optional, `string`) ... Correlator Id
+    + LOG_LEVEL (optional, `string`) ... Log level (INFO, ERROR, WARN, DEBUG, CRITICAL)
+    + CUSTOM_TEXT (optional, `string`) ... Custom text
++ Request (application/json)
+            {
+                "SERVICE_USER_NAME":"test_admin_service",
+                "SERVICE_USER_PASSWORD":"passwd",
+                "SERVICE_USER_TOKEN":"token",
+                "TRANSACTION_ID":"1552008898-556-00000004824",
+                "CORRELATOR_ID":"630a1245-6f72-4b33-a93e-f151a5e6b098",
+                "LOG_LEVEL":"ERROR",
+                "CUSTOM_TEXT":"core dumped"
+            }
++ Response 200 (application/json)
+    + Body { <splunk_output>  }
+
+## Search something relevant into subservice of a Service in Splunk [/v1.0/service/{serviceId}/subservice/{subserviceId}/relevant/{component}]
+
+### search something relevant into subservice of a Service [POST]
++ Parameters
+    + serviceId (required, `string`) ... Service Id
+    + subserviceId (required, `string`) ... SubService Id
+    + COMPONENT (required, `string`) ... IoT component (cygnus-ngsi, Orchestrator, Orion, STH, PEPorion, PEPsth, PEPperseo, PEPiotagent, perseo-fe, perseo-core, IoTAgent)
+    + TRANSACTION_ID (optional, `string`) ... Transaction Id
+    + CORRELATOR_ID (optional, `string`) ... Correlator Id
+    + LOG_LEVEL (optional, `string`) ... Log level (INFO, ERROR, WARN, DEBUG, CRITICAL)
+    + CUSTOM_TEXT (optional, `string`) ... Custom text
++ Request (application/json)
+            {
+                "SERVICE_USER_NAME":"test_admin_service",
+                "SERVICE_USER_PASSWORD":"passwd",
+                "SERVICE_USER_TOKEN":"token",
+                "TRANSACTION_ID":"1552008898-556-00000004824",
+                "CORRELATOR_ID":"630a1245-6f72-4b33-a93e-f151a5e6b098",
+                "LOG_LEVEL":"ERROR",
+                "CUSTOM_TEXT":"core dumped"
+            }
++ Response 200 (application/json)
+    + Body { <splunk_output>  }

bin/orchestrator-entrypoint.sh

@@ -58,6 +58,12 @@ MAILER_TO=smtpuser
 
 MONGODB_URI='localhost:27017'
 
+SPLUNK_HOST=localhost
+SPLUNK_PORT=8089
+SPLUNK_PROTOCOL=https
+SPLUNK_USER=user
+SPLUNK_PASSWORD=yourpassword
+
 PEP_PASSWORD=pep
 IOTAGENT_PASSWORD=iotagent
 
@@ -92,6 +98,9 @@ while [[ $# -gt 0 ]]; do
         -mailerhost)
             MAILER_HOST=$VALUE
             ;;
+        -splunkhost)
+            SPLUNK_HOST=$VALUE
+            ;;
         -keystoneport)
             KEYSTONE_PORT=$VALUE
             ;;
@@ -119,6 +128,9 @@ while [[ $# -gt 0 ]]; do
         -mailerport)
             MAILER_PORT=$VALUE
             ;;
+        -splunkport)
+            SPLUNK_PORT=$VALUE
+            ;;
         -ldapbasedn)
             LDAP_BASEDN=$VALUE
             ;;
@@ -146,6 +158,12 @@ while [[ $# -gt 0 ]]; do
         -cygnusmultiagent)
             CYGNUS_MULTIAGENT=$VALUE
             ;;
+        -splunkuser)
+            SPLUNK_USER=$VALUE
+            ;;
+        -splunkpasswd)
+            SPLUNK_PASSWORD=$VALUE
+            ;;
         -debuglevel)
             DEBUG_LEVEL=$VALUE
             ;;
@@ -276,6 +294,14 @@ sed -i ':a;N;$!ba;s/IOTAGENT = {[A-Za-z0-9,=@.\-\/\"\n: ]*}/IOTAGENT = { \
              \"password\": \"'$IOTAGENT_PASSWORD'\", \
 }/g' /opt/orchestrator/settings/dev.py
 
+sed -i ':a;N;$!ba;s/SPLUNK = {[A-Za-z0-9,=@.\-\/\"\n: ]*}/SPLUNK = { \
+             \"protocol\": \"'$SPLUNK_PROTOCOL'\", \
+             \"host\": \"'$SPLUNK_HOST'\", \
+             \"port\": \"'$SPLUNK_PORT'\", \
+             \"user\": \"'$SPLUNK_USER'\", \
+             \"password\": \"'$SPLUNK_PASSWORD'\", \
+}/g' /opt/orchestrator/settings/dev.py
+
 
 
 if [ "$DEBUG_LEVEL" ]; then

src/orchestrator/api/iotconf.py

@@ -114,6 +114,21 @@ def __init__(self):
                          "Forcing to use default conf values (127.0.0.1:27017)")
             self.MONGODB_URI = "mongnodb://127.0.0.1:27017"
 
+        try:
+            self.SPLUNK_PROTOCOL = settings.SPLUNK['protocol']
+            self.SPLUNK_HOST = settings.SPLUNK['host']
+            self.SPLUNK_PORT = settings.SPLUNK['port']
+            self.SPLUNK_USER = settings.SPLUNK['user']
+            self.SPLUNK_PASSWORD = settings.SPLUNK['password']
+        except KeyError:
+            logger.warn("SPLUNK endpoint configuration error. " +
+                        "Forcing to use default conf values (localhost)")
+            self.SPLUNK_HOST = "localhost"
+            self.SPLUNK_PORT = "8089"
+            self.SPLUNK_PROTOCOL = "https"
+            self.SPLUNK_USER = "user"
+            self.SPLUNK_PASSWORD = "pass"
+
 
     # Get Django status error from simple HTTP error code
     def getStatusFromCode(self, code):