[BACKPORT] Backport 2.4 commits to 2.x

.github/workflows/dashboards-observability-test-and-build-workflow.yml

@@ -11,8 +11,10 @@ env:
 jobs:
 
   build:
-
-    runs-on: ubuntu-latest
+    strategy: 
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: Checkout Plugin
@@ -57,13 +59,13 @@ jobs:
           yarn test --coverage
 
       - name: Upload coverage
+        if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: codecov/codecov-action@v1
         with:
           flags: dashboards-observability
           directory: ./OpenSearch-Dashboards/plugins/dashboards-observability
           token: ${{ secrets.CODECOV_TOKEN }}
 
-      # TODO remove hard coded version when observability is ready
       - name: Build Artifact
         run: |
           cd OpenSearch-Dashboards/plugins/dashboards-observability
@@ -73,6 +75,5 @@ jobs:
       - name: Upload Artifact
         uses: actions/upload-artifact@v1
         with:
-          name: dashboards-observability
-          path: ./OpenSearch-Dashboards/plugins/dashboards-observability/build
-
+          name: dashboards-observability-${{ matrix.os }}
+          path: ./OpenSearch-Dashboards/plugins/dashboards-observability/build

.github/workflows/opensearch-observability-test-and-build-workflow.yml

@@ -4,13 +4,18 @@ on: [pull_request, push]
 
 jobs:
   build:
+    env:
+      BUILD_ARGS: ${{ matrix.os_build_args }}
     strategy:
       matrix:
-        java:
-          - 11
-          - 17
-
-    runs-on: ubuntu-latest
+        java: [11, 17]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        include:
+          - os: windows-latest
+            os_build_args: -x integTest -x jacocoTestReport
+          - os: macos-latest
+            os_build_args: -x integTest -x jacocoTestReport
+    runs-on: ${{ matrix.os }}
 
     steps:
       - uses: actions/checkout@v1
@@ -21,6 +26,8 @@ jobs:
           java-version: ${{ matrix.java }}
 
       - name: Run Backwards Compatibility Tests
+        # Temporarily only do this for linux
+        if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           cd opensearch-observability
           echo "Running backwards compatibility tests ..."
@@ -29,9 +36,10 @@ jobs:
       - name: Build with Gradle
         run: |
           cd opensearch-observability
-          ./gradlew build
+          ./gradlew build ${{ env.BUILD_ARGS }}
 
       - name: Upload coverage
+        if: ${{ matrix.os == 'ubuntu-latest' }}
         uses: codecov/codecov-action@v1
         with:
           flags: opensearch-observability
@@ -46,5 +54,5 @@ jobs:
       - name: Upload Artifacts
         uses: actions/upload-artifact@v1
         with:
-          name: opensearch-observability
-          path: opensearch-observability-builds
+          name: opensearch-observability-${{ matrix.os }}
+          path: opensearch-observability-builds

DEVELOPER_GUIDE.md

@@ -14,14 +14,13 @@ By default, tests use the same runtime as `JAVA_HOME`.
 
 ### Setup
 
-1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in package.json](./dashboards-observability/package.json#L5).
-1. Download the OpenSearch Dashboards source code for the [version specified in package.json](./dashboards-observability/package.json#L5) you want to set up.
-
+1. Download OpenSearch for the version that matches the [OpenSearch Dashboards version specified in opensearch_dashboards.json](./dashboards-observability/opensearch_dashboards.json#L4) from [opensearch.org](https://opensearch.org/downloads.html).
+1. Download the OpenSearch Dashboards source code for the [version specified in opensearch_dashboards.json](./dashboards-observability/opensearch_dashboards.json#L4) you want to set up.
 1. Change your node version to the version specified in `.node-version` inside the OpenSearch Dashboards root directory.
-1. cd into `plugins` directory in the OpenSearch Dashboards source code directory.
-1. Check out this package from version control into the `plugins` directory.
+1. cd into `OpenSearch-Dashboards` and remove the `plugins` directory.
+1. Check out this package from version control as the `plugins` directory.
 ```bash
-git clone git@github.com:opensearch-project/observability.git plugins --no-checkout
+git clone https://github.com/opensearch-project/observability plugins --no-checkout
 cd plugins
 echo 'dashboards-observability/*' >> .git/info/sparse-checkout
 git config core.sparseCheckout true
@@ -46,9 +45,7 @@ Example output: `./build/observability*.zip`
 
 ### Run
 
-- `yarn start`
-
-  Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on `localhost:5601`.
+cd back to `OpenSearch-Dashboards` directory and run `yarn start` to start OpenSearch Dashboards including this plugin. OpenSearch Dashboards will be available on `localhost:5601`.
 
 ### Submitting Changes
 
@@ -60,4 +57,4 @@ The Github workflow in [`backport.yml`](.github/workflows/backport.yml) creates
 with an appropriate label `backport <backport-branch-name>` is merged to main with the backport workflow run successfully on the
 PR. For example, if a PR on main needs to be backported to `1.x` branch, add a label `backport 1.x` to the PR and make sure the
 backport workflow runs on the PR along with other checks. Once this PR is merged to main, the workflow will create a backport PR
-to the `1.x` branch.
+to the `1.x` branch.

README.md

@@ -126,7 +126,7 @@ See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project
 
 If you find a bug, or have a feature request, please don't hesitate to open an issue in this repository.
 
-For more information, see [project website](https://opensearch.org/) and [documentation](https://opensearch.org/docs). If you need help and are unsure where to open an issue, try [forums](https://discuss.opendistrocommunity.dev/).
+For more information, see [project website](https://opensearch.org/) and [documentation](https://opensearch.org/docs). If you need help and are unsure where to open an issue, try the [Forum](https://forum.opensearch.org/c/plugins/observability/49).
 
 ## Code of Conduct