Merge pull request #187 from o19s/176-dataprepper

Sending queries to Data Prepper

Dockerfile

@@ -2,4 +2,4 @@ FROM opensearchproject/opensearch:2.14.0
 
 COPY ./build/distributions/opensearch-ubi-0.0.12.1-os2.14.0.zip /tmp/
 
-RUN /usr/share/opensearch/bin/opensearch-plugin install file:/tmp/opensearch-ubi-0.0.12.1-os2.14.0.zip
+RUN /usr/share/opensearch/bin/opensearch-plugin install --batch file:/tmp/opensearch-ubi-0.0.12.1-os2.14.0.zip

README.md

@@ -24,8 +24,7 @@ For details on the JSON Schema used by UBI to send and receive queries and event
 
 ## Useful Commands
 
-* Get the indexed queries: `curl http://localhost:9200/ubi_queries/_search | jq`
-*
+The `scripts/` directory contains example UBI requests for common use cases.
 
 ## User Quick Start
 
@@ -37,10 +36,12 @@ To get started, download the plugin zip file from the [releases](https://github.
 bin/opensearch-plugin install file:/opensearch-ubi-1.0.0-os2.14.0.zip
 ```
 
+You will be prompted while installing the plugin beacuse the plugin defines additional security permissions. These permissions allow the plugin to serialize query requests to JSON for storing and to allow the plugin to send query requests to Data Prepper. You can skip the prompt by adding the `--batch` argument to the above command.
+
 To create the UBI indexes called `ubi_queries` and `ubi_events`, send a query to an OpenSearch index with the `ubi` query block added:
 
 ```
-curl -s http://localhost:9200/your-index/_search -H "Content-Type: application/json" -d'
+curl -s http://localhost:9200/ecommerce/_search -H "Content-Type: application/json" -d'
  {
   "ext": {
    "ubi": {
@@ -154,9 +155,11 @@ Similar to a query request, query responses will also include a `ubi` section in
 
 The only field present in the query response will be the `query_id`. The value of the `query_id` is the same as the `query_id` provided in the query, or, if not provided, a random UUID.
 
-### Indexed Queries
+### Indexing Queries
 
-To see how the query is indexed, you can search the `ubi_queries` index:
+Queries can be either indexed in the local OpenSearch in the `ubi_queries` index, or queries can be sent to a Data Prepper `http_source` endpoint.
+
+By default, queries are written to the local OpenSearch `ubi_queries` index as they are received. To see how the query is indexed, you can search the `ubi_queries` index:
 
 ```
 curl -s http://localhost:9200/ubi_queries/_search -H "Content-Type: application/json" | jq
@@ -206,6 +209,16 @@ Each indexed query will have the following fields:
 * `query` - The raw query that was provided to OpenSearch.
 * `timestamp` - The Unix timestamp when the query was indexed.
 
+#### Sending Queries to Data Prepper
+
+To send queries to Data Prepper, configure the following properties in OpenSearch:
+
+| Property            | Description                           | Example Value                 |
+|---------------------|---------------------------------------|-------------------------------|
+| ubi.dataprepper.url | Data Prepper's `http_source` endpoint | `http://localhost:2021/log/ingest` |
+
+With these properties set, queries will no longer be indexed into the local OpenSearch. The `ubi_queries` index can be deleted. Queries will be sent to Data Prepper as they are received by OpenSearch.
+
 ### Capturing Events
 
 The UBI plugin does *not* provide a way to capture client-side events. Sending client-side events requires action on the client to send the events to OpenSearch for indexing.

build.gradle

@@ -40,12 +40,16 @@ repositories {
     maven { url "https://plugins.gradle.org/m2/" }
 }
 
+thirdPartyAudit.enabled = false
+
 dependencies {
-    // required for the yaml test to run
-    yamlRestTestImplementation "org.apache.logging.log4j:log4j-core:${versions.log4j}"
     runtimeOnly "org.apache.logging.log4j:log4j-core:${versions.log4j}"
-    implementation "com.fasterxml.jackson.core:jackson-annotations:${versions.jackson}"
-    implementation "com.fasterxml.jackson.core:jackson-databind:${versions.jackson_databind}"
+    api "com.fasterxml.jackson.core:jackson-annotations:${versions.jackson}"
+    api "com.fasterxml.jackson.core:jackson-databind:${versions.jackson_databind}"
+    api "org.apache.httpcomponents:httpcore:${versions.httpcore}"
+    api "org.apache.httpcomponents:httpclient:${versions.httpclient}"
+    api "commons-logging:commons-logging:${versions.commonslogging}"
+    yamlRestTestImplementation "org.apache.logging.log4j:log4j-core:${versions.log4j}"
 }
 
 publishing {

dataprepper/data-prepper-config.yaml

@@ -0,0 +1 @@
+ssl: false

dataprepper/pipelines.yaml

@@ -0,0 +1,10 @@
+chorus-ubi-pipeline:
+  source:
+    http:
+      port: 2021
+      ssl: false
+  sink:
+    - opensearch:
+        hosts: [ "http://ubi-dev-os:9200" ]
+        index_type: custom
+        index: ubi_queries

docker-compose-cluster.yaml

@@ -2,7 +2,23 @@ version: '3.7'
 
 services:
 
-  os01:
+  dataprepper-dev-os:
+    depends_on:
+      - ubi-dev-os
+      - ubi-dev-os-2
+      - ubi-dev-os-3
+    container_name: dataprepper
+    image: opensearchproject/data-prepper:2.8.0
+    ports:
+      - 4900:4900
+      - 2021:2021
+    volumes:
+      - ./dataprepper/pipelines.yaml:/usr/share/data-prepper/pipelines/pipelines.yaml
+      - ./dataprepper/data-prepper-config.yaml:/usr/share/data-prepper/config/data-prepper-config.yaml 
+    networks:
+      - ubi-dev-os-net
+
+  ubi-dev-os:
     build: ./
     environment:
       node.name: os01
@@ -24,8 +40,10 @@ services:
     ports:
       - 9200:9200
       - 9600:9600
-
-  os02:
+    networks:
+      - ubi-dev-os-net
+
+  ubi-dev-os-2:
     build: ./
     environment:
       node.name: os02
@@ -44,8 +62,10 @@ services:
       nofile:
         soft: 65536
         hard: 65536
+    networks:
+      - ubi-dev-os-net
 
-  os03:
+  ubi-dev-os-3:
     build: ./
     environment:
       node.name: os03
@@ -64,9 +84,11 @@ services:
       nofile:
         soft: 65536
         hard: 65536
+    networks:
+      - ubi-dev-os-net
 
   os-dashboards:
-    image: opensearchproject/opensearch-dashboards:2.12.0
+    image: opensearchproject/opensearch-dashboards:2.14.0
     container_name: opensearch-dashboards
     ports:
       - 5601:5601
@@ -77,3 +99,5 @@ services:
       DISABLE_SECURITY_DASHBOARDS_PLUGIN: "true"
     depends_on:
       - os01
+    networks:
+      - ubi-dev-os-net

docker-compose.yaml

@@ -1,23 +1,29 @@
-version: '3'
-
 services:
+
+  dataprepper-dev-os:
+    depends_on:
+      - ubi-dev-os
+    container_name: dataprepper
+    image: opensearchproject/data-prepper:2.8.0
+    ports:
+      - 4900:4900
+      - 2021:2021
+    volumes:
+      - ./dataprepper/pipelines.yaml:/usr/share/data-prepper/pipelines/pipelines.yaml
+      - ./dataprepper/data-prepper-config.yaml:/usr/share/data-prepper/config/data-prepper-config.yaml 
+    networks:
+      - ubi-dev-os-net
+
   ubi-dev-os:
     build: ./
     container_name: ubi-dev-os 
     environment:
       discovery.type: single-node
       node.name: opensearch
       plugins.security.disabled: "true"
-#      See https://forum.opensearch.org/t/how-to-enable-cors-cross-origin-resource-sharing/426/3 for more
-      http.cors.enabled: true 
-#      Warning: this is opening it up to all cross domains
-#      http.cors.allow-origin: "http://localhost"...
-      http.cors.allow-origin: "*"
-      http.cors.allow-methods: OPTIONS,TRACE,HEAD,GET,POST,PUT,DELETE
-      http.cors.allow-credentials: true
-      http.cors.allow-headers: X-Requested-With,X-Auth-Token,Content-Type,Content-Length,Authorization,X-ubi-store,X-ubi-query-id,X-ubi-user-id,X-ubi-session-id
       logger.level: info
       OPENSEARCH_INITIAL_ADMIN_PASSWORD: SuperSecretPassword_123
+      #ubi.dataprepper.url: "http://dataprepper-dev-os:2021/log/ingest"
     ulimits:
       memlock:
         soft: -1

licenses/commons-logging-1.2.jar.sha1

@@ -0,0 +1 @@
+4bfc12adfe4842bf07b657f0369c4cb522955686

licenses/commons-logging-LICENSE.txt

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

licenses/commons-logging-NOTICE.txt

@@ -0,0 +1,5 @@
+Apache HttpComponents Core
+Copyright 2005-2024 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

licenses/httpclient-4.5.14.jar.sha1

@@ -0,0 +1 @@
+1194890e6f56ec29177673f2f12d0b8e627dec98