Skip to content
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.

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

Fix ObservabilityDevServicesConfigBuildItem usage - can be multiple, fix dup logging output #43945

Merged
merged 5 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

import java.util.Map;

import io.quarkus.builder.item.SimpleBuildItem;
import io.quarkus.builder.item.MultiBuildItem;

/**
* Build item used to carry running DevService values to Dev UI.
*/
public final class ObservabilityDevServicesConfigBuildItem extends SimpleBuildItem {
public final class ObservabilityDevServicesConfigBuildItem extends MultiBuildItem {

private final Map<String, String> config;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package io.quarkus.observability.deployment.devui;

import java.util.List;
import java.util.Map;
import java.util.Optional;

import org.apache.commons.lang3.StringUtils;

Expand All @@ -26,13 +26,13 @@ public class ObservabilityDevUIProcessor {
@BuildStep(onlyIf = IsDevelopment.class)
void createVersion(BuildProducer<CardPageBuildItem> cardPageBuildItemBuildProducer,
BuildProducer<FooterPageBuildItem> footerProducer,
Optional<ObservabilityDevServicesConfigBuildItem> configProps) {
List<ObservabilityDevServicesConfigBuildItem> configProps) {

// LGTM
if (configProps.isPresent()) {
Map<String, String> runtimeConfig = configProps.get().getConfig();
String grafanaUrl = runtimeConfig.getOrDefault("grafana.endpoint", "");
for (ObservabilityDevServicesConfigBuildItem cp : configProps) {
Map<String, String> runtimeConfig = cp.getConfig();

// LGTM
String grafanaUrl = runtimeConfig.getOrDefault("grafana.endpoint", "");
if (StringUtils.isNotEmpty(grafanaUrl)) {
final CardPageBuildItem card = new CardPageBuildItem();

Expand Down Expand Up @@ -65,6 +65,5 @@ void createVersion(BuildProducer<CardPageBuildItem> cardPageBuildItemBuildProduc
footerProducer.produce(new FooterPageBuildItem(mailLogPageBuilder));
}
}

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,13 @@

import org.eclipse.microprofile.config.Config;
import org.eclipse.microprofile.config.ConfigProvider;
import org.jboss.logging.Logger;
import org.testcontainers.utility.MountableFile;

import io.quarkus.devservices.common.JBossLoggingConsumer;
import io.quarkus.observability.common.ContainerConstants;
import io.quarkus.observability.common.config.AbstractGrafanaConfig;
import io.quarkus.observability.common.config.LgtmConfig;

public class LgtmContainer extends GrafanaContainer<LgtmContainer, LgtmConfig> {
/**
* Logger which will be used to capture container STDOUT and STDERR.
*/
private static final Logger log = Logger.getLogger(LgtmContainer.class);

protected static final String LGTM_NETWORK_ALIAS = "ltgm.testcontainer.docker";

protected static final String PROMETHEUS_CONFIG = """
Expand Down Expand Up @@ -47,7 +40,6 @@ public LgtmContainer(LgtmConfig config) {
// cannot override grafana-dashboards.yaml in the container because it's on a version dependent path:
// ./grafana-v11.0.0/conf/provisioning/dashboards/grafana-dashboards.yaml
// will replace contents of current dashboards
withLogConsumer(new JBossLoggingConsumer(log).withPrefix("LGTM"));
withCopyFileToContainer(
MountableFile.forClasspathResource("/grafana-dashboard-quarkus-micrometer-prometheus.json"),
"/otel-lgtm/grafana-dashboard-red-metrics-classic.json");
Expand All @@ -61,6 +53,11 @@ public LgtmContainer(LgtmConfig config) {

}

@Override
protected String prefix() {
return "LGTM";
}

public String getOtlpProtocol() {
return config.otlpProtocol();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@
import java.util.Set;
import java.util.function.Consumer;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.jboss.logging.Logger;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.containers.Network;
import org.testcontainers.containers.output.OutputFrame;
import org.testcontainers.images.builder.Transferable;
import org.testcontainers.utility.DockerImageName;

import io.quarkus.devservices.common.JBossLoggingConsumer;
import io.quarkus.observability.common.config.ContainerConfig;

@SuppressWarnings("resource")
public abstract class ObservabilityContainer<T extends ObservabilityContainer<T, C>, C extends ContainerConfig>
extends GenericContainer<T> {
private final Logger log = LoggerFactory.getLogger(getClass());
private final Logger dockerLog = LoggerFactory.getLogger(getClass().getName() + ".docker");

protected final Logger log = Logger.getLogger(getClass());

public ObservabilityContainer(C config) {
super(DockerImageName.parse(config.imageName()));
Expand All @@ -35,8 +35,10 @@ public ObservabilityContainer(C config) {
}
}

protected abstract String prefix();

protected Consumer<OutputFrame> frameConsumer() {
return frame -> logger().debug(frame.getUtf8String().stripTrailing());
return new JBossLoggingConsumer(log).withPrefix(prefix());
}

protected byte[] getResourceAsBytes(String resource) {
Expand All @@ -49,24 +51,19 @@ protected byte[] getResourceAsBytes(String resource) {

@SuppressWarnings("OctalInteger")
protected void addFileToContainer(byte[] content, String pathInContainer) {
logger().info("Content [{}]: \n{}", pathInContainer, new String(content, StandardCharsets.UTF_8));
log.infof("Content [%s]: \n{}", pathInContainer, new String(content, StandardCharsets.UTF_8));
withCopyToContainer(Transferable.of(content, 0777), pathInContainer);
}

@Override
protected Logger logger() {
return dockerLog;
}

@Override
public void start() {
log.info("Starting {} ...", getClass().getSimpleName());
log.infof("Starting %s ...", prefix());
super.start();
}

@Override
public void stop() {
log.info("Stopping {}...", getClass().getSimpleName());
log.infof("Stopping %s...", prefix());
super.stop();
}
}
Loading