Merge pull request #93 from lzap/foreman1

Initial version - foreman namespace/template

Author: richm

.gitignore

@@ -2,6 +2,7 @@
 *.template.json
 *~
 templates/*/*.asciidoc
+scripts/*.pyc
 
 # IDEA specific
 *.iml

namespaces/foreman.yml

@@ -0,0 +1,95 @@
+
+namespace:
+  name: foreman
+  type: group
+  description: >
+    Contains common fields specific to Foreman / Satellite 6 deployment.
+  fields:
+  - name: foreman_logger
+    type: keyword
+    description: >
+      Ruby on Rails logger name, one of: app, sql, permissions, audit, templates, ldap, telemetry, notifications or blob. Loggers can be individually enabled or disabled. For more info see Foreman's setting.yaml file.
+
+  - name: foreman_login
+    type: keyword
+    description: >
+      User login name who created the event.
+
+  - name: foreman_admin
+    type: boolean
+    description: >
+      Whether user who created the event is super admin or regular user.
+
+  - name: org_id
+    type: long
+    description: >
+      Organization database ID which created the event, if set.
+
+  - name: loc_id
+    type: long
+    description: >
+      Location database ID which created the event, if set.
+
+  - name: remote_ip
+    type: ip
+    description: >
+      IPv4 address of remote client which created the event, if available.
+
+  - name: request
+    type: keyword
+    description: >
+      format: [a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]
+      UUID of web request for events created in web request context.
+
+  - name: session
+    type: keyword
+    description: >
+      format: [a-zA-Z][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]
+      UUID of web session for events created in web request context. For session-less requests (e.g. API call) new session UUID is generated every time.
+
+  - name: exception
+    type: group
+    description: >
+      Contains common fields specific to Ruby (Ruby on Rails) exceptions.
+    fields:
+      - name: message
+        type: text
+        doc_values: false
+        description: >
+          Exception message
+
+      - name: class
+        type: keyword
+        description: >
+          Ruby exception class.
+
+      - name: backtrace
+        type: text
+        doc_values: false
+        description: >
+          Full exception backtrace (multiline text).
+
+  - name: template
+    type: group
+    description: >
+      Contains common fields specific to template renderers. Events only appear when "blob" logger is enabled. Rendered template contents is part of log message.
+    fields:
+      - name: name
+        type: keyword
+        description: >
+          Template name which was used to render content.
+
+      - name: digest
+        type: keyword
+        description: >
+          SHA256 of the rendered template contents.
+
+      - name: host_name
+        type: keyword
+        description: >
+          Host name which was associated with the template, if present.
+
+      - name: host_id
+        type: long
+        description: >
+          Host database ID which was associated with the template, if present.

templates/foreman/Makefile

@@ -0,0 +1,10 @@
+.PHONY: all clean docs
+
+all: docs
+	python ../../scripts/generate_template.py template.yml ../../namespaces/
+
+clean:
+	rm *.json *.asciidoc
+
+docs:
+	python ../../scripts/generate_template.py template.yml ../../namespaces/ --docs

templates/foreman/README.md

@@ -0,0 +1,14 @@
+# viaq collectd index templates for ElasticSearch
+
+The template files are automatically generated.
+Please _do not edit_ the files directly.
+
+In order to edit the template please modify [template.yml](template.yml) and
+the respective namespace files referenced there.
+
+To rebuild the template, run:
+> make
+
+# Contents
+
+The template contains mappings for Foreman deployment.

templates/foreman/template.yml

@@ -0,0 +1,12 @@
+skeleton_path: ../skeleton.json
+skeleton_index_pattern_path: ../skeleton-index-pattern.json
+
+elasticsearch_template:
+  name: org.foreman.viaq-cdm
+  index_pattern: "project.foreman-*"
+  order: 20
+
+namespaces:
+  - foreman.yml
+  - systemd.yml
+  - pipeline_metadata.yml