Apply suggestions from code review

Co-authored-by: Peter Štibraný <[email protected]> Signed-off-by: Vladimir Varankin <[email protected]>
grafana · Mar 12, 2024 · 52bcfd7 · 52bcfd7
1 parent f4e24c5
commit 52bcfd7
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/pkg/ingester/errors.go b/pkg/ingester/errors.go
@@ -29,12 +29,12 @@ import (
 const (
 	integerUnavailableMsgFormat = "ingester is unavailable (current state: %s)"
 	ingesterTooBusyMsg          = "ingester is currently too busy to process queries, try again later"
-	ingesterPushAPIDisabledMsg  = "ingester is configured with Push API disabled"
+	ingesterPushGrpcDisabledMsg = "ingester is configured with Push gRPC method disabled"
 )
 
 var (
-	errTooBusy         = ingesterTooBusyError{}
-	errPushAPIDisabled = newErrorWithStatus(ingesterPushAPIDisabledError{}, codes.Unimplemented)
+	errTooBusy          = ingesterTooBusyError{}
+	errPushGrpcDisabled = newErrorWithStatus(ingesterPushGrpcDisabledError{}, codes.Unimplemented)
 )
 
 // errorWithStatus is used for wrapping errors returned by ingester.
@@ -527,18 +527,18 @@ func (e ingesterTooBusyError) errorCause() mimirpb.ErrorCause {
 // Ensure that ingesterTooBusyError is an ingesterError.
 var _ ingesterError = ingesterTooBusyError{}
 
-type ingesterPushAPIDisabledError struct{}
+type ingesterPushGrpcDisabledError struct{}
 
-func (e ingesterPushAPIDisabledError) Error() string {
-	return ingesterPushAPIDisabledMsg
+func (e ingesterPushGrpcDisabledError) Error() string {
+	return ingesterPushGrpcDisabledMsg
 }
 
-func (e ingesterPushAPIDisabledError) errorCause() mimirpb.ErrorCause {
+func (e ingesterPushGrpcDisabledError) errorCause() mimirpb.ErrorCause {
 	return mimirpb.METHOD_NOT_ALLOWED
 }
 
-// Ensure that ingesterPushAPIDisabledError is an ingesterError.
-var _ ingesterError = ingesterPushAPIDisabledError{}
+// Ensure that ingesterPushGrpcDisabledError is an ingesterError.
+var _ ingesterError = ingesterPushGrpcDisabledError{}
 
 type ingesterErrSamplers struct {
 	sampleTimestampTooOld             *log.Sampler

diff --git a/pkg/ingester/ingester.go b/pkg/ingester/ingester.go
@@ -3490,7 +3490,7 @@ func (i *Ingester) checkAvailable() error {
 	return newUnavailableError(s)
 }
 
-// PushToStorage is a low-level implementation of Push() for block storage.
+// PushToStorage implements ingest.Pusher interface for ingestion via ingest-storage.
 func (i *Ingester) PushToStorage(ctx context.Context, req *mimirpb.WriteRequest) error {
 	err := i.PushWithCleanup(ctx, req, func() { mimirpb.ReuseSlice(req.Timeseries) })
 	if err != nil {
@@ -3499,10 +3499,10 @@ func (i *Ingester) PushToStorage(ctx context.Context, req *mimirpb.WriteRequest)
 	return nil
 }
 
-// Push implements client.IngesterServer
+// Push implements client.IngesterServer, which is registered into gRPC server.
 func (i *Ingester) Push(ctx context.Context, req *mimirpb.WriteRequest) (*mimirpb.WriteResponse, error) {
 	if !i.cfg.PushGrpcMethodEnabled {
-		return nil, errPushAPIDisabled
+		return nil, errPushGrpcDisabled
 	}
 
 	err := i.PushToStorage(ctx, req)

diff --git a/pkg/ingester/ingester_test.go b/pkg/ingester/ingester_test.go
@@ -6770,7 +6770,7 @@ func TestIngester_PushGrpcMethod_Disabled(t *testing.T) {
 		[]mimirpb.Sample{{TimestampMs: 1_000, Value: 1}},
 	)
 	_, err = i.Push(ctx, req)
-	require.ErrorIs(t, err, errPushAPIDisabled)
+	require.ErrorIs(t, err, errPushGrpcDisabled)
 }
 
 func TestIngester_instanceLimitsMetrics(t *testing.T) {