create and integrate the clientside resource client factory #9574

d-buckner · 2025-03-19T21:11:19Z

Description

This is to create a clientside API to surface data connection resources. With this PR I've implemented the prometheus resource API which will be used for dynamic query suggestions.

Changelog

skip

Check List

All tests pass
- yarn test:jest
- yarn test:jest_integration
New functionality includes testing.
New functionality has been documented.
Update CHANGELOG.md
Commits are signed per the DCO using --signoff

Signed-off-by: Daniel Rowe <[email protected]>

codecov · 2025-03-19T21:27:34Z

Codecov Report

Attention: Patch coverage is 7.14286% with 39 lines in your changes missing coverage. Please review.

Please upload report for BASE (feature/prometheus@d47ea0a). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
...pplication/view_components/utils/use_prometheus.ts	0.00%	14 Missing ⚠️
...gins/data/public/resources/base_resource_client.ts	14.28%	6 Missing ⚠️
...ata/public/resources/prometheus_resource_client.ts	20.00%	4 Missing ⚠️
...s/data/public/resources/resource_client_factory.ts	0.00%	4 Missing ⚠️
.../server/connections/managers/prometheus_manager.ts	0.00%	4 Missing ⚠️
...ery_enhancements/server/routes/resources/routes.ts	0.00%	4 Missing ⚠️
...onents/visualizations/vislib/line/to_expression.ts	25.00%	3 Missing ⚠️

Additional details and impacted files

@@                  Coverage Diff                  @@
##             feature/prometheus    #9574   +/-   ##
=====================================================
  Coverage                      ?   61.68%           
=====================================================
  Files                         ?     3829           
  Lines                         ?    92052           
  Branches                      ?    14590           
=====================================================
  Hits                          ?    56778           
  Misses                        ?    31617           
  Partials                      ?     3657

Flag	Coverage Δ
Linux_1	`28.94% <8.82%> (?)`
Linux_2	`56.39% <ø> (?)`
Linux_3	`39.24% <8.82%> (?)`
Linux_4	`28.81% <7.14%> (?)`
Windows_1	`28.96% <8.82%> (?)`
Windows_2	`56.34% <ø> (?)`
Windows_3	`39.24% <8.82%> (?)`
Windows_4	`28.81% <7.14%> (?)`

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: Daniel Rowe <[email protected]>

d-buckner · 2025-03-20T18:10:26Z

src/plugins/discover/public/application/components/visualizations/vislib/line/to_expression.ts

@@ -13,10 +13,13 @@ import { OpenSearchSearchHit } from '../../../../doc_views/doc_views_types';
 import { IndexPattern } from '../../../../../../../data/public';
 import { DiscoverViewServices } from '../../../../../build_services';

+type Source = Record<string, number | string>;


Apologies for tossing some vega formatting/type improvements in this unrelated PR

kavilla · 2025-03-20T19:43:46Z

src/plugins/data/public/resources/resource_client_factory.ts

+
+type DataConnectionType = 'prometheus';
+
+export class ResourceClientFactory {


ik just feature branch but would this be essentially be accomplished with a route on the server side

Yeah, this hits the data_enhancements resource API route in OSD server which proxies the request to the sql plugin in OS.

kavilla · 2025-03-20T19:44:44Z

src/plugins/discover/public/application/components/visualizations/vislib/line/to_expression.ts

    const yAxisParam = {
      field: columns[i].name,
      type: 'quantitative',
      scale: { zero: false },
-      axis: { titleColor: color, title: columns[i].name },
+      axis: { title: '' },


would this be breaking change? or just for demo purposes

This file is only used by the demo

kavilla · 2025-03-20T19:46:26Z

src/plugins/data/public/resources/base_resource_client.ts

+
+import { HttpSetup } from 'opensearch-dashboards/public';
+
+const BASE_API = 'api/enhancements';


prolly for feature branch purposes but data plugin doesn't depend on the enhancements plugin so might have to invert it

Yeah, I felt bad about this tbh. I'd like to move the query enhancement languages (sql, ppl, promql) autocompletion definitions to the query enhancement to avoid having this coupling in the data plugin. Once those are moved over I can define this resource client in data enhancements. Thoughts?

create and integrate the clientside resource client factory

51e498e

Signed-off-by: Daniel Rowe <[email protected]>

github-actions bot added the seasoned-contributor label Mar 19, 2025

d-buckner marked this pull request as ready for review March 19, 2025 21:11

github-actions bot added the Skip-Changelog PRs that are too trivial to warrant a changelog or release notes entry label Mar 19, 2025

d-buckner added 2 commits March 20, 2025 00:06

improve chart formatting and query loading

baa1792

Signed-off-by: Daniel Rowe <[email protected]>

create and integrate a clientside resource client factory

a8f1747

Signed-off-by: Daniel Rowe <[email protected]>

d-buckner force-pushed the prometheus branch from 60ab1ee to a8f1747 Compare March 20, 2025 17:19

improve typings

af47c2d

Signed-off-by: Daniel Rowe <[email protected]>

d-buckner force-pushed the prometheus branch from ba7cdf7 to af47c2d Compare March 20, 2025 18:08

d-buckner commented Mar 20, 2025

View reviewed changes

kavilla reviewed Mar 20, 2025

View reviewed changes

abbyhu2000 merged commit 80bf24e into opensearch-project:feature/prometheus Mar 24, 2025
55 of 72 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

create and integrate the clientside resource client factory #9574

create and integrate the clientside resource client factory #9574

d-buckner commented Mar 19, 2025

codecov bot commented Mar 19, 2025 •

edited

Loading

d-buckner Mar 20, 2025

kavilla Mar 20, 2025

d-buckner Mar 21, 2025

kavilla Mar 20, 2025

d-buckner Mar 21, 2025

kavilla Mar 20, 2025

d-buckner Mar 21, 2025 •

edited

Loading


		type DataConnectionType = 'prometheus';

		export class ResourceClientFactory {


		import { HttpSetup } from 'opensearch-dashboards/public';

		const BASE_API = 'api/enhancements';

create and integrate the clientside resource client factory #9574

create and integrate the clientside resource client factory #9574

Conversation

d-buckner commented Mar 19, 2025

Description

Changelog

Check List

codecov bot commented Mar 19, 2025 • edited Loading

Codecov Report

d-buckner Mar 20, 2025

Choose a reason for hiding this comment

kavilla Mar 20, 2025

Choose a reason for hiding this comment

d-buckner Mar 21, 2025

Choose a reason for hiding this comment

kavilla Mar 20, 2025

Choose a reason for hiding this comment

d-buckner Mar 21, 2025

Choose a reason for hiding this comment

kavilla Mar 20, 2025

Choose a reason for hiding this comment

d-buckner Mar 21, 2025 • edited Loading

Choose a reason for hiding this comment

codecov bot commented Mar 19, 2025 •

edited

Loading

d-buckner Mar 21, 2025 •

edited

Loading