Update docs

2026-08-02 13:42:19 +00:00 · 2024-03-04 10:50:50 -05:00
parent 51fd81a918
commit 10ef6fc135
29 changed files with 1408 additions and 100 deletions
@@ -3,7 +3,7 @@
 <head>
  <meta charset="utf-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; parsedmarc 8.7.0 documentation</title>
+  <title>Index &mdash; parsedmarc 8.8.0 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css" />

@@ -35,7 +35,7 @@
            parsedmarc
          </a>
              <div class="version">
-                8.7.0
+                8.8.0
              </div>
 <div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -51,6 +51,7 @@
 <li class="toctree-l1"><a class="reference internal" href="usage.html">Using parsedmarc</a></li>
 <li class="toctree-l1"><a class="reference internal" href="output.html">Sample outputs</a></li>
 <li class="toctree-l1"><a class="reference internal" href="elasticsearch.html">Elasticsearch and Kibana</a></li>
+<li class="toctree-l1"><a class="reference internal" href="opensearch.html">OpenSearch and Grafana</a></li>
 <li class="toctree-l1"><a class="reference internal" href="kibana.html">Using the Kibana dashboards</a></li>
 <li class="toctree-l1"><a class="reference internal" href="splunk.html">Splunk</a></li>
 <li class="toctree-l1"><a class="reference internal" href="davmail.html">Accessing an inbox using OWA/EWS</a></li>
@@ -94,6 +95,7 @@
 | <a href="#H"><strong>H</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#M"><strong>M</strong></a>
+ | <a href="#O"><strong>O</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#Q"><strong>Q</strong></a>
 | <a href="#S"><strong>S</strong></a>
@@ -104,7 +106,7 @@
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#parsedmarc.elastic.AlreadySaved">AlreadySaved</a>
+      <li><a href="api.html#parsedmarc.elastic.AlreadySaved">AlreadySaved</a>, <a href="api.html#parsedmarc.opensearch.AlreadySaved">[1]</a>
 </li>
  </ul></td>
 </tr></table>
@@ -117,7 +119,11 @@
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.elastic.create_indexes">create_indexes() (in module parsedmarc.elastic)</a>
+
+      <ul>
+        <li><a href="api.html#parsedmarc.opensearch.create_indexes">(in module parsedmarc.opensearch)</a>
 </li>
+      </ul></li>
  </ul></td>
 </tr></table>

@@ -211,7 +217,11 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.elastic.migrate_indexes">migrate_indexes() (in module parsedmarc.elastic)</a>
+
+      <ul>
+        <li><a href="api.html#parsedmarc.opensearch.migrate_indexes">(in module parsedmarc.opensearch)</a>
 </li>
+      </ul></li>
      <li>
    module

@@ -219,6 +229,8 @@
        <li><a href="api.html#module-parsedmarc">parsedmarc</a>
 </li>
        <li><a href="api.html#module-parsedmarc.elastic">parsedmarc.elastic</a>
+</li>
+        <li><a href="api.html#module-parsedmarc.opensearch">parsedmarc.opensearch</a>
 </li>
        <li><a href="api.html#module-parsedmarc.splunk">parsedmarc.splunk</a>
 </li>
@@ -228,6 +240,14 @@
  </ul></td>
 </tr></table>

+<h2 id="O">O</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#parsedmarc.opensearch.OpenSearchError">OpenSearchError</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
@@ -253,10 +273,10 @@
 </li>
      <li><a href="api.html#parsedmarc.parsed_forensic_reports_to_csv_rows">parsed_forensic_reports_to_csv_rows() (in module parsedmarc)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.parsed_smtp_tls_reports_to_csv">parsed_smtp_tls_reports_to_csv() (in module parsedmarc)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.parsed_smtp_tls_reports_to_csv_rows">parsed_smtp_tls_reports_to_csv_rows() (in module parsedmarc)</a>
 </li>
      <li>
@@ -271,6 +291,13 @@

      <ul>
        <li><a href="api.html#module-parsedmarc.elastic">module</a>
+</li>
+      </ul></li>
+      <li>
+    parsedmarc.opensearch
+
+      <ul>
+        <li><a href="api.html#module-parsedmarc.opensearch">module</a>
 </li>
      </ul></li>
      <li>
@@ -304,10 +331,14 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="api.html#parsedmarc.elastic.save_aggregate_report_to_elasticsearch">save_aggregate_report_to_elasticsearch() (in module parsedmarc.elastic)</a>
+</li>
+      <li><a href="api.html#parsedmarc.opensearch.save_aggregate_report_to_opensearch">save_aggregate_report_to_opensearch() (in module parsedmarc.opensearch)</a>
 </li>
      <li><a href="api.html#parsedmarc.splunk.HECClient.save_aggregate_reports_to_splunk">save_aggregate_reports_to_splunk() (parsedmarc.splunk.HECClient method)</a>
 </li>
      <li><a href="api.html#parsedmarc.elastic.save_forensic_report_to_elasticsearch">save_forensic_report_to_elasticsearch() (in module parsedmarc.elastic)</a>
+</li>
+      <li><a href="api.html#parsedmarc.opensearch.save_forensic_report_to_opensearch">save_forensic_report_to_opensearch() (in module parsedmarc.opensearch)</a>
 </li>
      <li><a href="api.html#parsedmarc.splunk.HECClient.save_forensic_reports_to_splunk">save_forensic_reports_to_splunk() (parsedmarc.splunk.HECClient method)</a>
 </li>
@@ -316,11 +347,17 @@
      <li><a href="api.html#parsedmarc.save_output">save_output() (in module parsedmarc)</a>
 </li>
      <li><a href="api.html#parsedmarc.elastic.save_smtp_tls_report_to_elasticsearch">save_smtp_tls_report_to_elasticsearch() (in module parsedmarc.elastic)</a>
+</li>
+      <li><a href="api.html#parsedmarc.opensearch.save_smtp_tls_report_to_opensearch">save_smtp_tls_report_to_opensearch() (in module parsedmarc.opensearch)</a>
 </li>
      <li><a href="api.html#parsedmarc.splunk.HECClient.save_smtp_tls_reports_to_splunk">save_smtp_tls_reports_to_splunk() (parsedmarc.splunk.HECClient method)</a>
 </li>
      <li><a href="api.html#parsedmarc.elastic.set_hosts">set_hosts() (in module parsedmarc.elastic)</a>
+
+      <ul>
+        <li><a href="api.html#parsedmarc.opensearch.set_hosts">(in module parsedmarc.opensearch)</a>
 </li>
+      </ul></li>
      <li><a href="api.html#parsedmarc.splunk.SplunkError">SplunkError</a>
 </li>
  </ul></td>