Remove minimum constraint on OpenSearch hosts to allow empty host and refactor status API to not include OpenSearch status when host is empty #4701

bandinib-amzn · 2023-08-09T01:06:00Z

Description

Remove minimum constraint on OpenSearch hosts to allow empty host.
Bypass node compatibility check when empty opensearch host is configured.
'Opensearch is not configured' message in status API when empty opensearch host is configured.

Please note no opensearch host is only considered when explicitly configured. That means you need to add opensearch.hosts: [] in opensearch_dashboards.yml file. Default value will remain same which is http://localhost:9200 in case opensearch.hosts is commented in opensearch_dashboards.yml file.

Issues Resolved

#4700

Screenshot

Status page when #opensearch.hosts: ["http://localhost:9200"] OR opensearch.hosts: ["http://localhost:9200"] in opensearch_dashboards.yml file.

Status page when opensearch.hosts:[] in opensearch_dashboards.yml file.

API Status response:

% curl localhost:5601/api/status | jq
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100 10279  100 10279    0     0  2987k      0 --:--:-- --:--:-- --:--:-- 3346k
{
  "name": "dev-dsk-bandinib-2c-1b8c3fb7.us-west-2.amazon.com",
  "uuid": "9e48a33a-9b44-4488-9cdc-22244cb1c8af",
  "version": {
    "number": "3.0.0",
    "build_hash": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "build_number": 9007199254740991,
    "build_snapshot": false
  },
  "status": {
    "overall": {
      "since": "2023-08-22T16:58:09.161Z",
      "state": "green",
      "title": "Green",
      "nickname": "Looking good",
      "icon": "success",
      "uiColor": "secondary"
    },
    "statuses": [
      {
        "id": "core:opensearch@3.0.0",
        "message": "Opensearch is not configured",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "core:savedObjects@3.0.0",
        "message": "Saved Object Service is using Postgres and it is up",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:advancedSettings@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:bfetch@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:charts@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:dataSourceManagement@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:devTools@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:discover@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:embeddable@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:expressions@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:indexPatternManagement@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:inspector@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:legacyExport@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:management@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:managementOverview@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:navigation@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:opensearchDashboardsOverview@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:opensearchDashboardsReact@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:opensearchDashboardsUsageCollection@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:opensearchDashboardsUtils@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:opensearchUiShared@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:savedObjects@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:savedObjectsManagement@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:share@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:uiActions@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:urlForwarding@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visDefaultEditor@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visualizations@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visualize@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:dashboardsStoragePlugin@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:apmOss@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:console@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:dashboard@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:data@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:dataSource@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:home@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:inputControlVis@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:mapsLegacy@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:opensearchDashboardsLegacy@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:regionMap@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:tileMap@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:usageCollection@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visAugmenter@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visBuilder@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visTypeMarkdown@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visTypeMetric@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visTypeTable@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visTypeTagcloud@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visTypeTimeline@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visTypeTimeseries@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visTypeVega@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      },
      {
        "id": "plugin:visTypeVislib@3.0.0",
        "message": "All dependencies are available",
        "since": "2023-08-22T16:58:09.161Z",
        "state": "green",
        "icon": "success",
        "uiColor": "secondary"
      }
    ]
  },
  "metrics": {
    "last_updated": "2023-08-22T16:58:07.854Z",
    "collection_interval_in_millis": 5000,
    "os": {
      "platform": "linux",
      "platformRelease": "linux-5.4.250-173.369.amzn2int.x86_64",
      "load": {
        "1m": 0.09,
        "5m": 0.11,
        "15m": 0.05
      },
      "memory": {
        "total_in_bytes": 16170184704,
        "free_in_bytes": 14283046912,
        "used_in_bytes": 1887137792
      },
      "uptime_in_millis": 134766270,
      "distro": "Amazon Linux",
      "distroRelease": "Amazon Linux-2 (Karoo)",
      "cpuacct": {
        "control_group": "/user.slice",
        "usage_nanos": 9161043095779
      },
      "cpu": {
        "control_group": "/user.slice",
        "cfs_period_micros": 100000,
        "cfs_quota_micros": -1,
        "stat": {
          "number_of_elapsed_periods": 0,
          "number_of_times_throttled": 0,
          "time_throttled_nanos": 0
        }
      }
    },
    "process": {
      "memory": {
        "heap": {
          "total_in_bytes": 127447040,
          "used_in_bytes": 110396848,
          "size_limit": 2197815296
        },
        "resident_set_size_in_bytes": 252866560
      },
      "pid": 19229,
      "event_loop_delay": 0.3745400011539459,
      "uptime_in_millis": 88092.057665
    },
    "response_times": {
      "avg_in_millis": 0,
      "max_in_millis": 0
    },
    "concurrent_connections": 6,
    "requests": {
      "disconnects": 0,
      "total": 0,
      "statusCodes": {},
      "status_codes": {}
    }
  }
}

Testing the changes

Check List

codecov · 2023-08-09T01:26:31Z

Codecov Report

Merging #4701 (862d2ca) into main (d7c5577) will increase coverage by 0.00%.
The diff coverage is 83.33%.

@@           Coverage Diff           @@
##             main    #4701   +/-   ##
=======================================
  Coverage   66.30%   66.30%           
=======================================
  Files        3322     3322           
  Lines       63919    63923    +4     
  Branches    10115    10117    +2     
=======================================
+ Hits        42381    42384    +3     
  Misses      19050    19050           
- Partials     2488     2489    +1

Flag	Coverage Δ
Linux_1	`34.84% <ø> (ø)`
Linux_2	`55.14% <83.33%> (+<0.01%)`	⬆️
Linux_3	`43.39% <0.00%> (-0.01%)`	⬇️
Linux_4	`35.10% <0.00%> (-0.01%)`	⬇️
Windows_1	`34.85% <ø> (ø)`
Windows_2	`55.10% <83.33%> (+<0.01%)`	⬆️
Windows_3	`43.40% <0.00%> (-0.01%)`	⬇️
Windows_4	`35.10% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Changed	Coverage Δ
src/core/server/opensearch/opensearch_config.ts	`93.58% <ø> (ø)`
src/core/server/opensearch/status.ts	`70.00% <0.00%> (-7.78%)`	⬇️
...rc/core/server/opensearch/client/cluster_client.ts	`84.21% <100.00%> (ø)`
src/core/server/opensearch/opensearch_service.ts	`84.61% <100.00%> (+1.28%)`	⬆️

zhongnansu

lgtm

AMoo-Miki · 2023-08-22T17:34:40Z

src/core/server/opensearch/status.ts

@@ -77,7 +77,7 @@ export const calculateStatus$ = (

          return {
            level: ServiceStatusLevels.available,
-            summary: `OpenSearch is available`,
+            summary: message ?? `OpenSearch is available`,


Suggested change

summary: message ?? `OpenSearch is available`,

summary: message || `OpenSearch is available`,

|| is a safer operator to guard against '' and false.

Though, i would prefer to be stricter..

Suggested change

summary: message ?? `OpenSearch is available`,

summary: (message ?? `OpenSearch is available`) || `Unknown`,

Good idea! Refactored to be more stricter.

Signed-off-by: Bandini Bhopi <bandinib@amazon.com>

Signed-off-by: Bandini Bhopi <bandinib@amazon.com> (cherry picked from commit 8e1ec99) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md

Signed-off-by: Bandini Bhopi <bandinib@amazon.com> (cherry picked from commit 8e1ec99) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> # Conflicts: # CHANGELOG.md Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Josh Romero <rmerqg@amazon.com>

github-actions bot added the valued-contributor label Aug 9, 2023

bandinib-amzn force-pushed the relax-nodecompatibility-check branch from 61e10d7 to ce08007 Compare August 9, 2023 19:42

bandinib-amzn marked this pull request as ready for review August 9, 2023 19:42

bandinib-amzn requested review from ananzh, kavilla, seanneumann, AMoo-Miki, ashwin-pc, joshuarrrr, abbyhu2000, zengyan-amazon, kristenTian, zhongnansu, manasvinibs, ZilongX, Flyingliuhub and BSFishy as code owners August 9, 2023 19:42

bandinib-amzn changed the title ~~Relax OpenSearch Node Compatibility check~~ [WIP] Relax OpenSearch Node Compatibility check Aug 9, 2023

bandinib-amzn force-pushed the relax-nodecompatibility-check branch 6 times, most recently from ab5b588 to 3b512ea Compare August 14, 2023 20:47

bandinib-amzn changed the title ~~[WIP] Relax OpenSearch Node Compatibility check~~ Remove minimum constraint on OpenSearch hosts to allow empty host Aug 14, 2023

bandinib-amzn changed the title ~~Remove minimum constraint on OpenSearch hosts to allow empty host~~ Remove minimum constraint on OpenSearch hosts to allow empty host and refactor status API to not include OpenSearch status when host is empty Aug 14, 2023

zhongnansu previously approved these changes Aug 14, 2023

View reviewed changes

bandinib-amzn added backport 2.x v2.10.0 labels Aug 14, 2023

bandinib-amzn force-pushed the relax-nodecompatibility-check branch from 3b512ea to 70c87cb Compare August 21, 2023 20:29

bandinib-amzn requested a review from curq as a code owner August 21, 2023 20:29

bandinib-amzn dismissed zhongnansu’s stale review via 202d8ba August 21, 2023 21:54

bandinib-amzn force-pushed the relax-nodecompatibility-check branch 2 times, most recently from 202d8ba to 64c8a50 Compare August 21, 2023 23:28

AMoo-Miki reviewed Aug 22, 2023

View reviewed changes

AMoo-Miki previously approved these changes Aug 22, 2023

View reviewed changes

Remove minimum constraint on opensearch hosts

862d2ca

Signed-off-by: Bandini Bhopi <bandinib@amazon.com>

bandinib-amzn dismissed AMoo-Miki’s stale review via 862d2ca August 22, 2023 21:43

bandinib-amzn force-pushed the relax-nodecompatibility-check branch from 64c8a50 to 862d2ca Compare August 22, 2023 21:43

AMoo-Miki approved these changes Aug 22, 2023

View reviewed changes

zhongnansu approved these changes Aug 23, 2023

View reviewed changes

zhongnansu merged commit 8e1ec99 into opensearch-project:main Aug 23, 2023

opensearch-trigger-bot bot mentioned this pull request Aug 23, 2023

[Backport 2.x] Remove minimum constraint on OpenSearch hosts to allow empty host and refactor status API to not include OpenSearch status when host is empty #4802

Merged

bandinib-amzn deleted the relax-nodecompatibility-check branch December 20, 2023 20:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove minimum constraint on OpenSearch hosts to allow empty host and refactor status API to not include OpenSearch status when host is empty #4701

Remove minimum constraint on OpenSearch hosts to allow empty host and refactor status API to not include OpenSearch status when host is empty #4701

bandinib-amzn commented Aug 9, 2023 •

edited

Loading

codecov bot commented Aug 9, 2023 •

edited

Loading

zhongnansu left a comment

AMoo-Miki Aug 22, 2023

AMoo-Miki Aug 22, 2023

bandinib-amzn Aug 22, 2023

	summary: message ?? `OpenSearch is available`,
	summary: message \|\| `OpenSearch is available`,

	summary: message ?? `OpenSearch is available`,
	summary: (message ?? `OpenSearch is available`) \|\| `Unknown`,

Remove minimum constraint on OpenSearch hosts to allow empty host and refactor status API to not include OpenSearch status when host is empty #4701

Remove minimum constraint on OpenSearch hosts to allow empty host and refactor status API to not include OpenSearch status when host is empty #4701

Conversation

bandinib-amzn commented Aug 9, 2023 • edited Loading

Description

Issues Resolved

Screenshot

Testing the changes

Check List

codecov bot commented Aug 9, 2023 • edited Loading

Codecov Report

zhongnansu left a comment

Choose a reason for hiding this comment

AMoo-Miki Aug 22, 2023

Choose a reason for hiding this comment

AMoo-Miki Aug 22, 2023

Choose a reason for hiding this comment

bandinib-amzn Aug 22, 2023

Choose a reason for hiding this comment

bandinib-amzn commented Aug 9, 2023 •

edited

Loading

codecov bot commented Aug 9, 2023 •

edited

Loading