am.ik.spring.opentelemetry.logs.otlp.PropertyMigrator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of otel-logs-autoconfigure Show documentation
OTEL Logs AutoConfigure for Spring Boot
The newest version!
/*
 * Copyright 2012-2024 the original author or authors.
 *
 * Licensed 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
 *
 *      https://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 am.ik.spring.opentelemetry.logs.otlp;

import java.util.Map;
import java.util.TreeMap;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.context.event.ApplicationPreparedEvent;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.boot.logging.DeferredLog;
import org.springframework.context.ApplicationListener;
import org.springframework.core.Ordered;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.EnumerablePropertySource;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.MutablePropertySources;
import org.springframework.core.env.PropertySource;

import static org.springframework.core.env.StandardEnvironment.SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME;

public class PropertyMigrator
		implements EnvironmentPostProcessor, Ordered, ApplicationListener {

	private static final DeferredLog log = new DeferredLog();

	public static final String SOURCE_NAME = "otlpLoggingPropertyMigrator";

	private static final String OLD_PREFIX = "management.otlp.logs";

	private static final String NEW_PREFIX = "management.otlp.logging";

	@Override
	public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
		Map properties = new TreeMap<>();
		environment.getPropertySources().forEach(propertySource -> {
			replace(propertySource, "endpoint", properties);
			replace(propertySource, "timeout", properties);
			replace(propertySource, "compression", properties);
			replacePrefix(propertySource, "headers", properties);
		});
		if (!properties.isEmpty()) {
			MapPropertySource propertySource = new MapPropertySource(SOURCE_NAME, properties);
			MutablePropertySources propertySources = environment.getPropertySources();
			if (propertySources.contains(SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME)) {
				propertySources.addBefore(SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, propertySource);
			}
			else {
				propertySources.addFirst(propertySource);
			}
		}
	}

	void replace(PropertySource propertySource, String key, Map properties) {
		String oldKey = OLD_PREFIX + "." + key;
		String newKey = NEW_PREFIX + "." + key;
		if (propertySource.containsProperty(oldKey) && !propertySource.containsProperty(newKey)) {
			log.warn("The old key '%s' is found in '%s'. Move the property to '%s'.".formatted(oldKey,
					propertySource.getName(), newKey));
			properties.put(newKey, propertySource.getProperty(oldKey));
		}
	}

	void replacePrefix(PropertySource propertySource, String key, Map properties) {
		String oldKeyPrefix = OLD_PREFIX + "." + key;
		String newKeyPrefix = NEW_PREFIX + "." + key;
		Object source = propertySource.getSource();
		if (source instanceof Map map) {
			for (Object k : map.keySet()) {
				replace(propertySource, properties, oldKeyPrefix, newKeyPrefix, k.toString());
			}
		}
		else if (propertySource instanceof EnumerablePropertySource enumerablePropertySource) {
			for (String oldKey : enumerablePropertySource.getPropertyNames()) {
				replace(propertySource, properties, oldKeyPrefix, newKeyPrefix, oldKey);
			}
		}
	}

	private void replace(PropertySource propertySource, Map properties, String oldKeyPrefix,
			String newKeyPrefix, String oldKey) {
		if (oldKey.startsWith(oldKeyPrefix)) {
			String newKey = oldKey.replace(oldKeyPrefix, newKeyPrefix);
			log.warn("The old key '%s' is found in '%s'. Move the property to '%s'.".formatted(oldKey,
					propertySource.getName(), newKey));
			properties.put(newKey, propertySource.getProperty(oldKey));
		}
	}

	@Override
	public int getOrder() {
		return Ordered.LOWEST_PRECEDENCE;
	}

	@Override
	public void onApplicationEvent(ApplicationPreparedEvent event) {
		log.replayTo(getClass());
	}

}