|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +package io.opentelemetry.instrumentation.api.incubator.config.internal; |
| 7 | + |
| 8 | +import io.opentelemetry.api.OpenTelemetry; |
| 9 | +import io.opentelemetry.api.incubator.config.DeclarativeConfigProperties; |
| 10 | +import java.util.function.Function; |
| 11 | +import java.util.logging.Logger; |
| 12 | +import javax.annotation.Nullable; |
| 13 | + |
| 14 | +/** |
| 15 | + * This class is internal and is hence not for public use. Its APIs are unstable and can change at |
| 16 | + * any time. |
| 17 | + */ |
| 18 | +public final class DbConfig { |
| 19 | + private static final Logger logger = Logger.getLogger(DbConfig.class.getName()); |
| 20 | + |
| 21 | + public static boolean isCommonQuerySanitizationEnabled(OpenTelemetry openTelemetry) { |
| 22 | + return isCommonQuerySanitizationEnabled(openTelemetry, true); |
| 23 | + } |
| 24 | + |
| 25 | + public static boolean isCommonQuerySanitizationEnabled( |
| 26 | + OpenTelemetry openTelemetry, boolean defaultValue) { |
| 27 | + Boolean querySanitizationEnabled = |
| 28 | + getCommonDbValue(openTelemetry, DbConfig::getQuerySanitizationEnabled); |
| 29 | + return querySanitizationEnabled != null ? querySanitizationEnabled : defaultValue; |
| 30 | + } |
| 31 | + |
| 32 | + public static boolean isQuerySanitizationEnabled( |
| 33 | + OpenTelemetry openTelemetry, String instrumentationName) { |
| 34 | + Boolean querySanitizationEnabled = |
| 35 | + getQuerySanitizationEnabled( |
| 36 | + DeclarativeConfigUtil.getInstrumentationConfig(openTelemetry, instrumentationName)); |
| 37 | + if (querySanitizationEnabled != null) { |
| 38 | + return querySanitizationEnabled; |
| 39 | + } |
| 40 | + return isCommonQuerySanitizationEnabled(openTelemetry); |
| 41 | + } |
| 42 | + |
| 43 | + public static boolean isCommonSqlCommenterEnabled( |
| 44 | + OpenTelemetry openTelemetry, boolean defaultValue) { |
| 45 | + Boolean sqlCommenterEnabled = getCommonSqlCommenterEnabled(openTelemetry); |
| 46 | + return sqlCommenterEnabled != null ? sqlCommenterEnabled : defaultValue; |
| 47 | + } |
| 48 | + |
| 49 | + public static boolean isSqlCommenterEnabled( |
| 50 | + OpenTelemetry openTelemetry, String instrumentationName) { |
| 51 | + return isSqlCommenterEnabled(openTelemetry, instrumentationName, false); |
| 52 | + } |
| 53 | + |
| 54 | + public static boolean isSqlCommenterEnabled( |
| 55 | + OpenTelemetry openTelemetry, String instrumentationName, boolean defaultValue) { |
| 56 | + Boolean sqlCommenterEnabled = |
| 57 | + getSqlCommenterEnabled( |
| 58 | + DeclarativeConfigUtil.getInstrumentationConfig(openTelemetry, instrumentationName)); |
| 59 | + if (sqlCommenterEnabled != null) { |
| 60 | + return sqlCommenterEnabled; |
| 61 | + } |
| 62 | + return isCommonSqlCommenterEnabled(openTelemetry, defaultValue); |
| 63 | + } |
| 64 | + |
| 65 | + @Nullable |
| 66 | + private static Boolean getCommonSqlCommenterEnabled(OpenTelemetry openTelemetry) { |
| 67 | + return getCommonDbValue(openTelemetry, DbConfig::getSqlCommenterEnabled); |
| 68 | + } |
| 69 | + |
| 70 | + @Nullable |
| 71 | + private static Boolean getCommonDbValue( |
| 72 | + OpenTelemetry openTelemetry, Function<DeclarativeConfigProperties, Boolean> configReader) { |
| 73 | + DeclarativeConfigProperties commonConfig = |
| 74 | + DeclarativeConfigUtil.getInstrumentationConfig(openTelemetry, "common"); |
| 75 | + |
| 76 | + Boolean value = configReader.apply(commonConfig.get("db")); |
| 77 | + if (value != null) { |
| 78 | + return value; |
| 79 | + } |
| 80 | + |
| 81 | + Boolean deprecatedValue = configReader.apply(commonConfig.get("database")); |
| 82 | + if (deprecatedValue != null) { |
| 83 | + logger.warning( |
| 84 | + "common.database is deprecated in declarative configuration" |
| 85 | + + " and has been replaced by common.db."); |
| 86 | + return deprecatedValue; |
| 87 | + } |
| 88 | + |
| 89 | + return null; |
| 90 | + } |
| 91 | + |
| 92 | + @Nullable |
| 93 | + private static Boolean getQuerySanitizationEnabled(DeclarativeConfigProperties config) { |
| 94 | + Boolean value = config.get("query_sanitization").getBoolean("enabled"); |
| 95 | + if (value != null) { |
| 96 | + return value; |
| 97 | + } |
| 98 | + |
| 99 | + Boolean deprecatedValue = config.get("statement_sanitizer").getBoolean("enabled"); |
| 100 | + if (deprecatedValue != null) { |
| 101 | + logger.warning( |
| 102 | + "statement_sanitizer is deprecated in declarative configuration" |
| 103 | + + " and has been replaced by query_sanitization."); |
| 104 | + return deprecatedValue; |
| 105 | + } |
| 106 | + |
| 107 | + return null; |
| 108 | + } |
| 109 | + |
| 110 | + @Nullable |
| 111 | + private static Boolean getSqlCommenterEnabled(DeclarativeConfigProperties config) { |
| 112 | + return config.get("sqlcommenter/development").getBoolean("enabled"); |
| 113 | + } |
| 114 | + |
| 115 | + private DbConfig() {} |
| 116 | +} |
0 commit comments