opensearch field

Author: terrywbrady

src-admintool/web/index.html

@@ -297,8 +297,9 @@ <h2>Merritt Internals</h2>
         <li class="graph"><a class="json" href="{{ADMINTOOL_HOME}}?path=admin_obj_agg">Merritt Admin Objects Count</a></li>
         <li class="coll"><a class="json" href="{{ADMINTOOL_HOME}}?path=admin_coll">Collections Table Special Cases</a></li>
         <li class="config"><a href="{{COLLADMIN_HOME}}?path=instances">Merritt Servers</a></li>
-          <li class="config"><a href="{{COLLADMIN_HOME}}?path=ssm-describe">SSM Parameter Registry</a></li>
-      </ul>
+        <li class="config"><a href="{{COLLADMIN_HOME}}?path=ssm-describe">SSM Parameter Registry</a></li>
+        <li class="config"><a href="{{COLLADMIN_HOME}}?path=opensearch-describe">OpenSearch Field Registry</a></li>
+        </ul>
     </div>
 
     <div class="nav_section nav_merritt_users nav_merritt_internals">

src-colladmin/actions/opensearch_describe_action.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require_relative 'action'
+require 'yaml'
+
+# Collection Admin Task class - see config/actions.yml for description
+class OpenSearchDescribeAction < AdminAction
+  def initialize(config, action, path, myparams)
+    super(config, action, path, myparams)
+    file = 'import/filebeat/fields.json'
+    @title = "Merritt OpenSearch Fields (#{File.ctime(file).to_s[0..15]})"
+    @fields = JSON.parse(File.read(file))
+    #load_registry
+  end
+
+  def load_registry
+    reg = YAML.safe_load(File.read('import/filebeat/opensearch.registry.yml'), aliases: true)
+    process_registry_node(LambdaBase.ssm_root_path.chop, reg)
+  end
+
+  def process_registry_node(path, reg)
+    if reg.key?('description')
+      p = @parameters.fetch(path, SsmInfo.new(path))
+      p.set_description(reg['description'])
+      p.set_deprecated(reg.fetch('deprecated', ''))
+      p.set_skip(reg.fetch('skip', false))
+      @parameters[path] = p
+      return
+    end
+
+    reg.each_key do |k|
+      r = reg[k]
+      next unless r.instance_of?(::Hash)
+
+      process_registry_node("#{path}/#{k}", r)
+    end
+
+    return unless reg.fetch('skip', false)
+
+    @parameters.each_key do |pp|
+      next unless pp =~ /^#{path}.*/
+
+      @parameters[pp].set_skip(true)
+    end
+  end
+
+  def get_title
+    @title
+  end
+
+  def table_headers
+    ['Field Name', 'Type', 'Statis']
+  end
+
+  def table_types
+    ['name', '', 'status']
+  end
+
+  def perform_action
+    convert_json_to_table({}.to_json)
+  end
+
+  def table_rows(_body)
+    rows = []
+    @fields.each do |val|
+      name = val.fetch('name', '')
+      next if name =~ /\.keyword$/
+      type = val.fetch('type', '')
+      rows.append([name, type, 'PASS'])
+    end
+    rows
+  end
+
+  def has_table
+    true
+  end
+
+  def get_alternative_queries
+    []
+  end
+
+  def init_status
+    :PASS
+  end
+end

src-colladmin/config/actions.yml

@@ -371,6 +371,18 @@ ssm-describe:
     These variables are compared against a [registry of expected SSM variables](https://github.com/CDLUC3/mrt-admin-lambda/blob/main/src-colladmin/config/ssm.registry.yml).
   documentation: |
     Aws: SSM Query
+opensearch-describe:
+  link-title: List and Describe Merritt OpenSearch Fields
+  breadcrumb: bp_internals
+  class: OpenSearchDescribeAction
+  category: Dev Ops
+  sensitivity: readonly
+  testing: automated
+  description: |
+    Generate a report describing the OpenSearch fields generated from Merritt application logs.
+    These variables are compared against a [TBD registry of expected OpenSearch fields](https://github.com/CDLUC3/mrt-admin-lambda/blob/main/src-colladmin/import/filebeat/opensearch.registry.yml).
+  documentation: |
+    Aws: OpenSearch Query
 storage-get-manifest:
   link-title: Get Storage Manifest for an Object from Cloud Storage
   class: StorageAction

src-colladmin/import/filebeat/README.md

@@ -2,4 +2,12 @@
 
 - export `filebeat-uc3-mrt-prd*` index pattern saved object
 - save as `filebeat.ndjson`
-- run `ruby fields.rb filebeat.ndjson > fields.json`
+- run `ruby fields.rb filebeat.ndjson > fields.json`
+
+## By saving fields.json to git, we can notice diffs in our field useage
+
+- [fields.json](fields.json)
+
+## TODO
+
+Much like the documentation that we have for our SSM variables, this file can be used to document the opensearch index fields in use by Merritt applications.