Move remote write API to client_golang/exp #1711

saswatamcode · 2025-01-17T11:55:24Z

Moving to exp.

Do we want to create new client in this remote write API addition as well? Or do future iteration on it? :)

I might add the decompression middleware stuff here as well

cc: @bwplotka

Signed-off-by: Saswata Mukherjee <[email protected]>

bwplotka · 2025-01-17T12:21:08Z

I would straight away try to avoid old client shenigans and rethink this from scratch.

Signed-off-by: Saswata Mukherjee <[email protected]>

saswatamcode · 2025-01-18T15:04:55Z

exp/api/remote/remote_api.go

+	baseURL *url.URL
+	client  *http.Client


Passing http.Client directly here instead of api.Client structs. Seems like the most flexible way, without doing custom configs.

saswatamcode · 2025-01-18T15:06:42Z

exp/api/remote/remote_api.go

+// SnappyDecompressorMiddleware returns a middleware that checks if the request body is snappy-encoded and decompresses it.
+// If the request body is not snappy-encoded, it returns an error.
+// Used by default in NewRemoteWriteHandler.
+func SnappyDecompressorMiddleware(logger *slog.Logger) func(http.Handler) http.Handler {


Tried to convert this into a middleware with the ability for downstream users to override and add their own middlewares if needed.

Let me know what you think, or if this is too much

No, this is great, thanks!

Signed-off-by: Saswata Mukherjee <[email protected]>

bwplotka · 2025-01-20T14:51:21Z

Can we create a go mod file? It has to be a separate Go module if it will be experimental.

kakkoyun

Looking good.

We need documentation:

We need a README. And we need to make the intention crystal clear.
Also, we have to be clear, we don't give any guarantees that the experimental APIs won't introduce breaking changes, or they will eventually be promoted to stable.
How do we release? This suppose to have different release cycles and maybe tags.

kakkoyun · 2025-01-20T14:55:23Z

Looking good.

We need documentation:

We need a README. And we need to make the intention crystal clear.

Also, we have to be clear, we don't give any guarantees that the experimental APIs won't introduce breaking changes, or they will eventually be promoted to stable.

How do we release? This suppose to have different release cycles and maybe tags.

Additionally, we need experiment owners. So that we can ping them on the issues.

Signed-off-by: Saswata Mukherjee <[email protected]>

saswatamcode · 2025-01-20T16:30:09Z

go.work

Added a workspace file as well

saswatamcode · 2025-01-20T16:36:38Z

We need a README. And we need to make the intention crystal clear.

Yup, probably some example usage helps

Also, we have to be clear, we don't give any guarantees that the experimental APIs won't introduce breaking changes, or they will eventually be promoted to stable.

exp package go doc has a line on this, but yes probably something to mention in dedicated README. Might be good to do this in next PR to prwclient-em branch?

Signed-off-by: Saswata Mukherjee <[email protected]>

bwplotka · 2025-01-31T12:44:33Z

go.work

+go 1.21
+
+use (
+	.


Nice, thanks!

bwplotka

Epic, let's try this how it looks on the main PR 💪🏽
Thanks!

…t and handler. (#1658) * api: Add remote API with write client; add remote handler. Signed-off-by: bwplotka <[email protected]> * Make Write message type more flexble, address some feedback (#1710) * Address remaining feedback Signed-off-by: Saswata Mukherjee <[email protected]> * Make Write message type more flexible Signed-off-by: Saswata Mukherjee <[email protected]> --------- Signed-off-by: Saswata Mukherjee <[email protected]> * Move remote write API to client_golang/exp (#1711) * Move remote write API to client_golang/exp Signed-off-by: Saswata Mukherjee <[email protected]> * Don't use api.Client structs, add options for middleware Signed-off-by: Saswata Mukherjee <[email protected]> * Fix reqBuf usage Signed-off-by: Saswata Mukherjee <[email protected]> * Fix url path Signed-off-by: Saswata Mukherjee <[email protected]> * Add separate mod file (and workspace file) Signed-off-by: Saswata Mukherjee <[email protected]> * Hook exp tests fmt; Test handler error case; Configure backoff Signed-off-by: Saswata Mukherjee <[email protected]> --------- Signed-off-by: Saswata Mukherjee <[email protected]> * exp: Add README, address feedback, use sync.Pool (#1747) * Implement suggestion for Store interface and contentType Signed-off-by: Saswata Mukherjee <[email protected]> * Add README Signed-off-by: Saswata Mukherjee <[email protected]> * Use sync.Pool Signed-off-by: Saswata Mukherjee <[email protected]> * Implement review suggestions Signed-off-by: Saswata Mukherjee <[email protected]> * Release bufs right after compressPayload Signed-off-by: Saswata Mukherjee <[email protected]> --------- Signed-off-by: Saswata Mukherjee <[email protected]> * Bump exp to go 1.22 Signed-off-by: Saswata Mukherjee <[email protected]> --------- Signed-off-by: bwplotka <[email protected]> Signed-off-by: Saswata Mukherjee <[email protected]> Signed-off-by: Bartlomiej Plotka <[email protected]> Co-authored-by: Saswata Mukherjee <[email protected]>

…t and handler. (prometheus#1658) * api: Add remote API with write client; add remote handler. Signed-off-by: bwplotka <[email protected]> * Make Write message type more flexble, address some feedback (prometheus#1710) * Address remaining feedback Signed-off-by: Saswata Mukherjee <[email protected]> * Make Write message type more flexible Signed-off-by: Saswata Mukherjee <[email protected]> --------- Signed-off-by: Saswata Mukherjee <[email protected]> * Move remote write API to client_golang/exp (prometheus#1711) * Move remote write API to client_golang/exp Signed-off-by: Saswata Mukherjee <[email protected]> * Don't use api.Client structs, add options for middleware Signed-off-by: Saswata Mukherjee <[email protected]> * Fix reqBuf usage Signed-off-by: Saswata Mukherjee <[email protected]> * Fix url path Signed-off-by: Saswata Mukherjee <[email protected]> * Add separate mod file (and workspace file) Signed-off-by: Saswata Mukherjee <[email protected]> * Hook exp tests fmt; Test handler error case; Configure backoff Signed-off-by: Saswata Mukherjee <[email protected]> --------- Signed-off-by: Saswata Mukherjee <[email protected]> * exp: Add README, address feedback, use sync.Pool (prometheus#1747) * Implement suggestion for Store interface and contentType Signed-off-by: Saswata Mukherjee <[email protected]> * Add README Signed-off-by: Saswata Mukherjee <[email protected]> * Use sync.Pool Signed-off-by: Saswata Mukherjee <[email protected]> * Implement review suggestions Signed-off-by: Saswata Mukherjee <[email protected]> * Release bufs right after compressPayload Signed-off-by: Saswata Mukherjee <[email protected]> --------- Signed-off-by: Saswata Mukherjee <[email protected]> * Bump exp to go 1.22 Signed-off-by: Saswata Mukherjee <[email protected]> --------- Signed-off-by: bwplotka <[email protected]> Signed-off-by: Saswata Mukherjee <[email protected]> Signed-off-by: Bartlomiej Plotka <[email protected]> Co-authored-by: Saswata Mukherjee <[email protected]>

Move remote write API to client_golang/exp

d32e301

Signed-off-by: Saswata Mukherjee <[email protected]>

saswatamcode mentioned this pull request Jan 17, 2025

exp/api: Add experimental exp module; Add remote API with write client and handler. #1658

Merged

2 tasks

saswatamcode marked this pull request as draft January 17, 2025 11:56

Don't use api.Client structs, add options for middleware

9392687

Signed-off-by: Saswata Mukherjee <[email protected]>

saswatamcode commented Jan 18, 2025

View reviewed changes

saswatamcode added 2 commits January 19, 2025 13:06

Fix reqBuf usage

3858538

Signed-off-by: Saswata Mukherjee <[email protected]>

Fix url path

a7eceb3

Signed-off-by: Saswata Mukherjee <[email protected]>

kakkoyun reviewed Jan 20, 2025

View reviewed changes

Add separate mod file (and workspace file)

e7dbd12

Signed-off-by: Saswata Mukherjee <[email protected]>

saswatamcode commented Jan 20, 2025

View reviewed changes

go.work Outdated

Copy link

Member Author

saswatamcode Jan 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a workspace file as well

Hook exp tests fmt; Test handler error case; Configure backoff

ea04374

Signed-off-by: Saswata Mukherjee <[email protected]>

saswatamcode marked this pull request as ready for review January 24, 2025 10:44

bwplotka reviewed Jan 31, 2025

View reviewed changes

go.work

go 1.21

use (

.

Copy link

Member

bwplotka Jan 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

bwplotka approved these changes Jan 31, 2025

View reviewed changes

bwplotka merged commit 433de68 into prometheus:prwclient-em Jan 31, 2025
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move remote write API to client_golang/exp #1711

Move remote write API to client_golang/exp #1711

saswatamcode commented Jan 17, 2025 •

edited

Loading

bwplotka commented Jan 17, 2025

saswatamcode Jan 18, 2025

saswatamcode Jan 18, 2025

bwplotka Jan 31, 2025

bwplotka commented Jan 20, 2025

kakkoyun left a comment

kakkoyun commented Jan 20, 2025

saswatamcode Jan 20, 2025

saswatamcode commented Jan 20, 2025

bwplotka Jan 31, 2025

bwplotka left a comment

+              go 1.21
+              use (
+              	.

Move remote write API to client_golang/exp #1711

Move remote write API to client_golang/exp #1711

Conversation

saswatamcode commented Jan 17, 2025 • edited Loading

bwplotka commented Jan 17, 2025

saswatamcode Jan 18, 2025

Choose a reason for hiding this comment

saswatamcode Jan 18, 2025

Choose a reason for hiding this comment

bwplotka Jan 31, 2025

Choose a reason for hiding this comment

bwplotka commented Jan 20, 2025

kakkoyun left a comment

Choose a reason for hiding this comment

kakkoyun commented Jan 20, 2025

saswatamcode Jan 20, 2025

Choose a reason for hiding this comment

saswatamcode commented Jan 20, 2025

bwplotka Jan 31, 2025

Choose a reason for hiding this comment

bwplotka left a comment

Choose a reason for hiding this comment

saswatamcode commented Jan 17, 2025 •

edited

Loading