Skip to content

Fix deserialization of kafka producer json config in the kafka-reporter-plugin. #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
May 31, 2023
Merged

Fix deserialization of kafka producer json config in the kafka-reporter-plugin. #542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
daf58f3
Fix the gson dependency in the kafka-reporter-plugin. (#10848)
gzlicanyi May 26, 2023
9a1ad5d
Fix the gson dependency by maven-shade-plugin in the kafka-reporter-p…
gzlicanyi May 26, 2023
07d15fd
Merge branch 'apache:main' into main
gzlicanyi May 26, 2023
c4c7e49
Fix deserialization of kafka producer json config in the kafka-report…
gzlicanyi May 31, 2023
f0c0c7c
add changes doc
gzlicanyi May 31, 2023
e953bf6
add com.google.common shade in the kafka-reporter-plugin.
gzlicanyi May 31, 2023
1df8d64
Fix com.google.common shade in the kafka-reporter-plugin.
gzlicanyi May 31, 2023
c4ef0e5
Change use gson TypeToken in the KafkaProducerManager.
gzlicanyi May 31, 2023
4a6ec1c
Merge commit 'c04a71472' into sw8-main
gzlicanyi May 31, 2023
0ca303d
delete kafka code
gzlicanyi May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Release Notes.
* Fix possible IllegalStateException when using Micrometer.
* Support Grizzly Work ThreadPool Metric Monitor
* Fix the gson dependency in the kafka-reporter-plugin.
* Fix deserialization of kafka producer json config in the kafka-reporter-plugin.
* Support to config custom decode methods for kafka configurations

#### Documentation
Expand Down
22 changes: 13 additions & 9 deletions ...plugin/src/main/java/org/apache/skywalking/apm/agent/core/kafka/KafkaProducerManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@

package org.apache.skywalking.apm.agent.core.kafka;

import com.google.gson.reflect.TypeToken;
import com.google.gson.Gson;

import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.HashSet;
Expand All @@ -34,7 +34,6 @@
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.stream.Collectors;

import org.apache.kafka.clients.admin.AdminClient;
import org.apache.kafka.clients.admin.DescribeTopicsResult;
import org.apache.kafka.clients.producer.KafkaProducer;
Expand Down Expand Up @@ -107,11 +106,7 @@ public void run() {
Properties properties = new Properties();
properties.setProperty(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, Kafka.BOOTSTRAP_SERVERS);

if (StringUtil.isNotEmpty(Kafka.PRODUCER_CONFIG_JSON)) {
Gson gson = new Gson();
Map<String, String> config = (Map<String, String>) gson.fromJson(Kafka.PRODUCER_CONFIG_JSON, Map.class);
decode(config).forEach(properties::setProperty);
}
setPropertiesFromJsonConfig(properties);
decode(Kafka.PRODUCER_CONFIG).forEach(properties::setProperty);

try (AdminClient adminClient = AdminClient.create(properties)) {
Expand All @@ -131,12 +126,12 @@ public void run() {
})
.filter(Objects::nonNull)
.collect(Collectors.toSet());

if (!topics.isEmpty()) {
LOGGER.warn("kafka topics {} is not exist, connect to kafka cluster abort", topics);
return;
}

try {
producer = new KafkaProducer<>(properties, new StringSerializer(), new BytesSerializer());
} catch (Exception e) {
Expand All @@ -149,6 +144,15 @@ public void run() {
}
}

void setPropertiesFromJsonConfig(Properties properties) {
if (StringUtil.isNotEmpty(Kafka.PRODUCER_CONFIG_JSON)) {
Gson gson = new Gson();
Map<String, String> config = gson.fromJson(Kafka.PRODUCER_CONFIG_JSON,
new TypeToken<Map<String, String>>() { }.getType());
decode(config).forEach(properties::setProperty);
}
}

private void notifyListeners(KafkaConnectionStatus status) {
for (KafkaConnectionStatusListener listener : listeners) {
listener.onStatusChanged(status);
Expand Down
24 changes: 17 additions & 7 deletions ...in/src/test/java/org/apache/skywalking/apm/agent/core/kafka/KafkaProducerManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,15 @@

package org.apache.skywalking.apm.agent.core.kafka;

import org.junit.Test;

import static org.junit.Assert.assertEquals;
import java.lang.reflect.Method;
import java.util.Properties;
import java.util.concurrent.atomic.AtomicInteger;
import org.junit.Test;
import java.nio.charset.StandardCharsets;
import java.util.Base64;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;

import static org.junit.Assert.assertEquals;

public class KafkaProducerManagerTest {
@Test
Expand All @@ -39,8 +38,8 @@ public void testAddListener() throws Exception {
kafkaProducerManager.addListener(new MockListener(counter));
}
Method notifyListeners = kafkaProducerManager
.getClass()
.getDeclaredMethod("notifyListeners", KafkaConnectionStatus.class);
.getClass()
.getDeclaredMethod("notifyListeners", KafkaConnectionStatus.class);
notifyListeners.setAccessible(true);
notifyListeners.invoke(kafkaProducerManager, KafkaConnectionStatus.CONNECTED);

Expand All @@ -60,6 +59,17 @@ public void testFormatTopicNameThenRegister() {
assertEquals(KafkaReporterPluginConfig.Plugin.Kafka.TOPIC_METRICS, value);
}

@Test
public void testSetPropertiesFromJsonConfig() {
KafkaProducerManager kafkaProducerManager = new KafkaProducerManager();
Properties properties = new Properties();

KafkaReporterPluginConfig.Plugin.Kafka.PRODUCER_CONFIG_JSON = "{\"batch.size\":32768}";
kafkaProducerManager.setPropertiesFromJsonConfig(properties);

assertEquals(properties.get("batch.size"), "32768");
}

Comment on lines +62 to +72
Copy link
Member

@wu-sheng wu-sheng May 31, 2023

Choose a reason for hiding this comment

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

What does this UT prove? The codes are not shaded ever in the UT scope, right?

Copy link
Contributor Author

@gzlicanyi gzlicanyi May 31, 2023

Choose a reason for hiding this comment

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

Show an example of how a JSON configuration can be correctly set to properties.

Copy link
Contributor Author

@gzlicanyi gzlicanyi May 31, 2023

Choose a reason for hiding this comment

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

What does this UT prove? The codes are not shaded ever in the UT scope, right?

right.

Copy link
Member

@wu-sheng wu-sheng May 31, 2023

Choose a reason for hiding this comment

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

So, the point of this PR is TypeToken, which cast the type accordingly.

But still import com.google.common.reflect.TypeToken; seems not from gson package. Why?

Copy link
Contributor Author

@gzlicanyi gzlicanyi May 31, 2023

Choose a reason for hiding this comment

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

So, the point of this PR is TypeToken, which cast the type accordingly.

But still import com.google.common.reflect.TypeToken; seems not from gson package. Why?

I have used the wrong TypeToken out of two.

@Test
public void testDecode() throws Exception {
KafkaReporterPluginConfig.Plugin.Kafka.DECODE_CLASS = "org.apache.skywalking.apm.agent.core.kafka.KafkaProducerManagerTest$DecodeTool";
Expand Down