[improve][io]add metrics to elastic search sink #20498
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.io.elasticsearch; | ||
|
|
||
| import org.apache.pulsar.io.core.SinkContext; | ||
|
|
||
| /* | ||
| * Metrics class for ElasticSearchSink | ||
| */ | ||
| public class ElasticSearchMetrics { | ||
|
|
||
| private SinkContext sinkContext; | ||
|
|
||
| // sink metrics | ||
| public static final String INCOMING = "_elasticsearch_incoming_"; | ||
|
There was a problem hiding this comment. static final goes before private variables |
||
|
|
||
| // INCOMING = SUCCESS + FAILURE + SKIP + NULLVALUE_IGNORE | ||
| public static final String SUCCESS = "_elasticsearch_success_"; | ||
|
|
||
| // DELETE is an attempt to delete a document by id | ||
| public static final String DELETE = "elasticsearch_delete_"; | ||
| public static final String FAILURE = "elasticsearch_failure_"; | ||
| public static final String SKIP = "elasticsearch_skip_"; | ||
| public static final String WARN = "elasticsearch_warn_"; | ||
| public static final String MALFORMED_IGNORE = "elasticsearch_malformed_ignore_"; | ||
| public static final String NULLVALUE_IGNORE = "elasticsearch_nullvalue_ignore_"; | ||
|
|
||
| public ElasticSearchMetrics(SinkContext sinkContext) { | ||
| this.sinkContext = sinkContext; | ||
| } | ||
|
|
||
| public void incrementCounter(String counter, double value) { | ||
| if (sinkContext != null) { | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. removed the if evaluation |
||
| this.sinkContext.recordMetric(counter, value); | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -53,6 +53,7 @@ | |
| import org.apache.pulsar.io.core.SinkContext; | ||
| import org.apache.pulsar.io.core.annotations.Connector; | ||
| import org.apache.pulsar.io.core.annotations.IOType; | ||
| import org.opensearch.index.engine.Engine.Delete; | ||
|
|
||
| @Connector( | ||
| name = "elastic_search", | ||
|
|
@@ -65,6 +66,7 @@ public class ElasticSearchSink implements Sink<GenericObject> { | |
|
|
||
| private ElasticSearchConfig elasticSearchConfig; | ||
| private ElasticSearchClient elasticsearchClient; | ||
| private ElasticSearchMetrics metrics; | ||
| private final ObjectMapper objectMapper = new ObjectMapper(); | ||
| private ObjectMapper sortedObjectMapper; | ||
| private List<String> primaryFields = null; | ||
|
|
@@ -75,7 +77,8 @@ public class ElasticSearchSink implements Sink<GenericObject> { | |
| public void open(Map<String, Object> config, SinkContext sinkContext) throws Exception { | ||
| elasticSearchConfig = ElasticSearchConfig.load(config, sinkContext); | ||
| elasticSearchConfig.validate(); | ||
| metrics = new ElasticSearchMetrics(sinkContext); | ||
| elasticsearchClient = new ElasticSearchClient(elasticSearchConfig, metrics); | ||
| if (!Strings.isNullOrEmpty(elasticSearchConfig.getPrimaryFields())) { | ||
| primaryFields = Arrays.asList(elasticSearchConfig.getPrimaryFields().split(",")); | ||
| } | ||
|
|
@@ -109,7 +112,7 @@ void setElasticsearchClient(ElasticSearchClient elasticsearchClient) { | |
|
|
||
| @Override | ||
| public void write(Record<GenericObject> record) throws Exception { | ||
| metrics.incrementCounter(ElasticSearchMetrics.INCOMING, 1); | ||
| if (!elasticsearchClient.isFailed()) { | ||
| Pair<String, String> idAndDoc = extractIdAndDocument(record); | ||
| try { | ||
|
|
@@ -120,22 +123,21 @@ public void write(Record<GenericObject> record) throws Exception { | |
| switch (elasticSearchConfig.getNullValueAction()) { | ||
| case DELETE: | ||
| if (idAndDoc.getLeft() != null) { | ||
| metrics.incrementCounter(ElasticSearchMetrics.DELETE, 1); | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. @asafm I changed to DELETE_ATTEMPT to count the number of attempts. I'm having a problem to separate DELETE or index in the bulk operation. This requires more code change. Can I do this in another PR? We do need a delete_attempt count that helps to track if or how many delete documents requests. Would you help me to add the DELETE counter in another PR? There was a problem hiding this comment. Don't you prefer to first fix the code to have everything you need and only then add the metrics? |
||
| if (elasticSearchConfig.isBulkEnabled()) { | ||
| elasticsearchClient.bulkDelete(record, idAndDoc.getLeft()); | ||
| } else { | ||
| elasticsearchClient.deleteDocument(record, idAndDoc.getLeft()); | ||
| } | ||
| } else { | ||
| metrics.incrementCounter(ElasticSearchMetrics.SKIP, 1); | ||
| } | ||
| break; | ||
| case IGNORE: | ||
| metrics.incrementCounter(ElasticSearchMetrics.NULLVALUE_IGNORE, 1); | ||
| break; | ||
| case FAIL: | ||
| metrics.incrementCounter(ElasticSearchMetrics.FAILURE, 1); | ||
| elasticsearchClient.failed( | ||
| new PulsarClientException.InvalidMessageException("Unexpected null message value")); | ||
| throw elasticsearchClient.irrecoverableError.get(); | ||
|
|
@@ -148,32 +150,32 @@ public void write(Record<GenericObject> record) throws Exception { | |
| } | ||
| } | ||
| } catch (JsonProcessingException jsonProcessingException) { | ||
| // this is from non-bulk action | ||
| // a generical failure counter should have been incremented | ||
| switch (elasticSearchConfig.getMalformedDocAction()) { | ||
| case IGNORE: | ||
| metrics.incrementCounter(ElasticSearchMetrics.MALFORMED_IGNORE, 1); | ||
| break; | ||
| case WARN: | ||
| metrics.incrementCounter(ElasticSearchMetrics.WARN, 1); | ||
| log.warn("Ignoring malformed document messageId={}", | ||
| record.getMessage().map(Message::getMessageId).orElse(null), | ||
| jsonProcessingException); | ||
| elasticsearchClient.failed(jsonProcessingException); | ||
| throw jsonProcessingException; | ||
| case FAIL: | ||
| log.error("Malformed document messageId={}", | ||
| record.getMessage().map(Message::getMessageId).orElse(null), | ||
| jsonProcessingException); | ||
| elasticsearchClient.failed(jsonProcessingException); | ||
| throw jsonProcessingException; | ||
| } | ||
| } catch (Exception e) { | ||
| log.error("write error for {} {}:", idAndDoc.getLeft(), idAndDoc.getRight(), e); | ||
| throw e; | ||
| } | ||
| } else { | ||
| metrics.incrementCounter(ElasticSearchMetrics.FAILURE, 1); | ||
| throw new IllegalStateException("Elasticsearch client is in FAILED status"); | ||
| } | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you already did the work, wouldn't you prefer to go all the way?
metrics.incrementCounter(ElasticSearchMetrics.SUCCESS, index);--->metrics.recordRecordIndexedSuccess()?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually it should be incremented by 1. The counter pegging along with message acknowledgement is in an iteration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My point is changing the structure of the methods, not if it's by 1 or not :)