Source generator for ConfigurationsKeys2 (temporary) to replace ConfigurationsKeys.cs later

Author: anna-git

tracer/src/Datadog.Trace.SourceGenerators/Configuration/ConfigurationKeysGenerator.cs

@@ -31,4 +31,17 @@ internal class TrackingNames
     public const string AssemblyCallTargetDefinitionSource = nameof(AssemblyCallTargetDefinitionSource);
     public const string AdoNetCallTargetDefinitionSource = nameof(AdoNetCallTargetDefinitionSource);
     public const string AdoNetSignatures = nameof(AdoNetSignatures);
+
+    // Configuration key matcher
+    public const string ConfigurationKeysParseConfiguration = nameof(ConfigurationKeysParseConfiguration);
+    public const string ConfigurationKeyMatcherDiagnostics = nameof(ConfigurationKeyMatcherDiagnostics);
+    public const string ConfigurationKeyMatcherValidData = nameof(ConfigurationKeyMatcherValidData);
+    public const string ConfigurationKeysAdditionalText = nameof(ConfigurationKeysAdditionalText);
+
+    // Configuration key generator
+    public const string ConfigurationKeysGenParseConfiguration = nameof(ConfigurationKeysGenParseConfiguration);
+    public const string ConfigurationKeysGenContentExtracted = nameof(ConfigurationKeysGenContentExtracted);
+    public const string ConfigurationKeysGenMatcherValidData = nameof(ConfigurationKeysGenMatcherValidData);
+    public const string ConfigurationKeysGenAdditionalText = nameof(ConfigurationKeysGenAdditionalText);
+    public const string ConfigurationKeysGenYamlAdditionalText = nameof(ConfigurationKeysGenYamlAdditionalText);
 }

tracer/src/Datadog.Trace.SourceGenerators/Helpers/TrackingNames.cs

@@ -0,0 +1,142 @@
+// <copyright file="YamlReader.cs" company="Datadog">
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
+// </copyright>
+
+using System.Collections.Generic;
+using System.Text;
+
+namespace Datadog.Trace.SourceGenerators.Helpers
+{
+    /// <summary>
+    /// Simple YAML parser for reading documentation strings from YAML files.
+    /// Supports basic YAML features needed for configuration documentation.
+    /// </summary>
+    internal static class YamlReader
+    {
+        /// <summary>
+        /// Parses a YAML file containing configuration key documentation.
+        /// Expects format: KEY: | followed by multi-line documentation
+        /// </summary>
+        public static Dictionary<string, string> ParseDocumentation(string yamlContent)
+        {
+            var result = new Dictionary<string, string>();
+            var lines = yamlContent.Replace("\r\n", "\n").Split('\n');
+
+            string? currentKey = null;
+            var currentDoc = new StringBuilder();
+            var inMultiLine = false;
+            var baseIndent = 0;
+
+            for (int i = 0; i < lines.Length; i++)
+            {
+                var line = lines[i];
+
+                // Skip empty lines and comments when not in multi-line
+                if (!inMultiLine && (string.IsNullOrWhiteSpace(line) || line.TrimStart().StartsWith("#")))
+                {
+                    continue;
+                }
+
+                // Check for new key (starts at column 0, contains colon)
+                if (!inMultiLine && line.Length > 0 && line[0] != ' ' && line.Contains(":"))
+                {
+                    // Save previous key if exists
+                    if (currentKey != null)
+                    {
+                        result[currentKey] = currentDoc.ToString().TrimEnd();
+                        currentDoc.Clear();
+                    }
+
+                    var colonIndex = line.IndexOf(':');
+                    currentKey = line.Substring(0, colonIndex).Trim();
+
+                    // Check if it's a multi-line string (|)
+                    var afterColon = line.Substring(colonIndex + 1).Trim();
+                    if (afterColon == "|" || afterColon == ">")
+                    {
+                        inMultiLine = true;
+                        baseIndent = -1; // Will be set on first content line
+                    }
+                    else if (!string.IsNullOrEmpty(afterColon))
+                    {
+                        // Single line value
+                        currentDoc.Append(afterColon);
+                        result[currentKey] = currentDoc.ToString();
+                        currentDoc.Clear();
+                        currentKey = null;
+                    }
+
+                    continue;
+                }
+
+                // Handle multi-line content
+                if (inMultiLine && currentKey != null)
+                {
+                    // Check if we've reached the next key (no indentation)
+                    if (line.Length > 0 && line[0] != ' ' && line.Contains(":"))
+                    {
+                        // Save current key and process this line as new key
+                        result[currentKey] = currentDoc.ToString().TrimEnd();
+                        currentDoc.Clear();
+                        inMultiLine = false;
+
+                        var colonIndex = line.IndexOf(':');
+                        currentKey = line.Substring(0, colonIndex).Trim();
+                        var afterColon = line.Substring(colonIndex + 1).Trim();
+                        if (afterColon == "|" || afterColon == ">")
+                        {
+                            inMultiLine = true;
+                            baseIndent = -1;
+                        }
+
+                        continue;
+                    }
+
+                    // Determine base indentation from first content line
+                    if (baseIndent == -1 && line.Length > 0 && line[0] == ' ')
+                    {
+                        baseIndent = 0;
+                        while (baseIndent < line.Length && line[baseIndent] == ' ')
+                        {
+                            baseIndent++;
+                        }
+                    }
+
+                    // Add content line (remove base indentation)
+                    if (line.Length > 0)
+                    {
+                        var contentStart = 0;
+                        while (contentStart < line.Length && contentStart < baseIndent && line[contentStart] == ' ')
+                        {
+                            contentStart++;
+                        }
+
+                        if (currentDoc.Length > 0)
+                        {
+                            currentDoc.AppendLine();
+                        }
+
+                        currentDoc.Append(line.Substring(contentStart));
+                    }
+                    else
+                    {
+                        // Empty line in multi-line content
+                        if (currentDoc.Length > 0)
+                        {
+                            currentDoc.AppendLine();
+                        }
+                    }
+                }
+            }
+
+            // Save last key
+            if (currentKey != null)
+            {
+                result[currentKey] = currentDoc.ToString().TrimEnd();
+            }
+
+            return result;
+        }
+    }
+}

tracer/src/Datadog.Trace.SourceGenerators/Helpers/YamlReader.cs

@@ -0,0 +1,66 @@
+// <copyright company="Datadog">
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
+// </copyright>
+// <auto-generated/>
+
+#nullable enable
+
+// This file is auto-generated from supported-configurations.json and supported-configurations-docs.yaml
+// Do not edit this file directly. The source generator will regenerate it on build.
+// NOTE: If you remove keys/products from the JSON, run 'dotnet clean' to remove old generated files.
+
+namespace Datadog.Trace.Configuration;
+
+internal static partial class ConfigurationKeys2
+{
+    internal static class AppSec
+    {
+        public const string ApiSecurityEnabled = "DD_API_SECURITY_ENABLED";
+        public const string ApiSecurityEndpointCollectionEnabled = "DD_API_SECURITY_ENDPOINT_COLLECTION_ENABLED";
+        public const string ApiSecurityEndpointCollectionMessageLimit = "DD_API_SECURITY_ENDPOINT_COLLECTION_MESSAGE_LIMIT";
+        public const string ApiSecurityParseResponseBody = "DD_API_SECURITY_PARSE_RESPONSE_BODY";
+        public const string ApiSecuritySampleDelay = "DD_API_SECURITY_SAMPLE_DELAY";
+        public const string AutoUserInstrumentationMode = "DD_APPSEC_AUTO_USER_INSTRUMENTATION_MODE";
+        public const string AutomatedUserEventsTracking = "DD_APPSEC_AUTOMATED_USER_EVENTS_TRACKING";
+
+        /// <summary>
+        /// Configuration key for enabling or disabling the AppSec.
+        /// Default is value is false (disabled).
+        /// </summary>
+        public const string Enabled = "DD_APPSEC_ENABLED";
+
+        /// <summary>
+        /// Comma separated keys indicating the optional custom headers the user wants to send.
+        /// Default is value is null.
+        /// </summary>
+        public const string ExtraHeaders = "DD_APPSEC_EXTRA_HEADERS";
+        public const string HttpBlockedTemplateHtml = "DD_APPSEC_HTTP_BLOCKED_TEMPLATE_HTML";
+        public const string HttpBlockedTemplateJson = "DD_APPSEC_HTTP_BLOCKED_TEMPLATE_JSON";
+
+        /// <summary>
+        /// Configuration key indicating the optional name of the custom header to take into account for the ip address.
+        /// Default is value is null (do not override).
+        /// </summary>
+        public const string Ipheader = "DD_APPSEC_IPHEADER";
+        public const string KeepTraces = "DD_APPSEC_KEEP_TRACES";
+        public const string MaxStackTraceDepth = "DD_APPSEC_MAX_STACK_TRACE_DEPTH";
+        public const string MaxStackTraceDepthTopPercent = "DD_APPSEC_MAX_STACK_TRACE_DEPTH_TOP_PERCENT";
+        public const string MaxStackTraces = "DD_APPSEC_MAX_STACK_TRACES";
+        public const string ObfuscationParameterKeyRegexp = "DD_APPSEC_OBFUSCATION_PARAMETER_KEY_REGEXP";
+        public const string ObfuscationParameterValueRegexp = "DD_APPSEC_OBFUSCATION_PARAMETER_VALUE_REGEXP";
+        public const string RaspEnabled = "DD_APPSEC_RASP_ENABLED";
+
+        /// <summary>
+        /// Override the default rules file provided. Must be a path to a valid JSON rules file.
+        /// Default is value is null (do not override).
+        /// </summary>
+        public const string Rules = "DD_APPSEC_RULES";
+        public const string ScaEnabled = "DD_APPSEC_SCA_ENABLED";
+        public const string StackTraceEnabled = "DD_APPSEC_STACK_TRACE_ENABLED";
+        public const string TraceRateLimit = "DD_APPSEC_TRACE_RATE_LIMIT";
+        public const string WafDebug = "DD_APPSEC_WAF_DEBUG";
+        public const string WafTimeout = "DD_APPSEC_WAF_TIMEOUT";
+        public const string ExperimentalAppsecUseUnsafeEncoder = "DD_EXPERIMENTAL_APPSEC_USE_UNSAFE_ENCODER";
+    }
+}

tracer/src/Datadog.Trace/Generated/net461/Datadog.Trace.SourceGenerators/ConfigurationKeysGenerator/ConfigurationKeys2.AppSec.g.cs

@@ -0,0 +1,32 @@
+// <copyright company="Datadog">
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
+// </copyright>
+// <auto-generated/>
+
+#nullable enable
+
+// This file is auto-generated from supported-configurations.json and supported-configurations-docs.yaml
+// Do not edit this file directly. The source generator will regenerate it on build.
+// NOTE: If you remove keys/products from the JSON, run 'dotnet clean' to remove old generated files.
+
+namespace Datadog.Trace.Configuration;
+
+internal static partial class ConfigurationKeys2
+{
+    internal static class AzureAppService
+    {
+        public const string AasDotnetExtensionVersion = "DD_AAS_DOTNET_EXTENSION_VERSION";
+
+        /// <summary>
+        /// Used to force the loader to start dogstatsd (in case automatic instrumentation is disabled)
+        /// </summary>
+        public const string AasEnableCustomMetrics = "DD_AAS_ENABLE_CUSTOM_METRICS";
+
+        /// <summary>
+        /// Used to force the loader to start the trace agent (in case automatic instrumentation is disabled)
+        /// </summary>
+        public const string AasEnableCustomTracing = "DD_AAS_ENABLE_CUSTOM_TRACING";
+        public const string s = "DD_AZURE_APP_SERVICES";
+    }
+}