Be consistent about using snake case in metadata yaml (#13610)

Author: jaydeluca

docs/instrumentation-list.yaml

@@ -50,9 +50,9 @@ public class SpringWebInstrumentationModule extends InstrumentationModule
 * name
   * Identifier for instrumentation module, used to enable/disable
   * Configured in `InstrumentationModule` code for each module
-* srcPath
+* source_path
   * Path to the source code of the instrumentation module
-* minimumJavaVersion
+* minimum_java_version
   * Minimum Java version required by the instrumentation module. If not specified, it is assumed to
     be Java 8
 * description
@@ -73,7 +73,7 @@ As of now, the following fields are supported:
 
 ```yaml
 description: "Description of what the instrumentation does."
-disabledByDefault: true
+disabled_by_default: true
 
 # used to mark modules that do not instrument traditional libraries (e.g. methods, annotations)
 # defaults to true

instrumentation-docs/readme.md

@@ -9,17 +9,18 @@
 import javax.annotation.Nullable;
 
 /**
- * This class is internal and is hence not for public use. Its APIs are unstable and can change at
- * any time.
+ * Represents the data in a metadata.yaml file. This class is internal and is hence not for public
+ * use. Its APIs are unstable and can change at any time.
  */
 public class InstrumentationMetaData {
+  @Nullable private String description;
+  @Nullable private Boolean isLibraryInstrumentation;
+  @Nullable private Boolean disabledByDefault;
 
   public InstrumentationMetaData() {}
 
   public InstrumentationMetaData(String description) {
     this.description = description;
-    this.isLibraryInstrumentation = true;
-    this.disabledByDefault = false;
   }
 
   public InstrumentationMetaData(
@@ -29,10 +30,6 @@ public InstrumentationMetaData(
     this.description = description;
   }
 
-  @Nullable private String description;
-  @Nullable private Boolean disabledByDefault;
-  @Nullable private Boolean isLibraryInstrumentation;
-
   @Nullable
   public String getDescription() {
     return description;

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/internal/InstrumentationMetaData.java

@@ -15,10 +15,20 @@
 import java.util.TreeMap;
 import java.util.stream.Collectors;
 import org.yaml.snakeyaml.DumperOptions;
+import org.yaml.snakeyaml.TypeDescription;
 import org.yaml.snakeyaml.Yaml;
 
 public class YamlHelper {
 
+  private static final Yaml metaDataYaml = new Yaml();
+
+  static {
+    TypeDescription customDescriptor = new TypeDescription(InstrumentationMetaData.class);
+    customDescriptor.substituteProperty(
+        "disabled_by_default", Boolean.class, "getDisabledByDefault", "setDisabledByDefault");
+    metaDataYaml.addTypeDescription(customDescriptor);
+  }
+
   public static void printInstrumentationList(
       List<InstrumentationEntity> list, BufferedWriter writer) {
     Map<String, List<InstrumentationEntity>> groupedByGroup =
@@ -43,14 +53,14 @@ public static void printInstrumentationList(
               }
 
               if (entity.getMetadata().getDisabledByDefault()) {
-                entityMap.put("disabledByDefault", entity.getMetadata().getDisabledByDefault());
+                entityMap.put("disabled_by_default", entity.getMetadata().getDisabledByDefault());
               }
             }
 
-            entityMap.put("srcPath", entity.getSrcPath());
+            entityMap.put("source_path", entity.getSrcPath());
 
             if (entity.getMinJavaVersion() != null) {
-              entityMap.put("minimumJavaVersion", entity.getMinJavaVersion());
+              entityMap.put("minimum_java_version", entity.getMinJavaVersion());
             }
 
             Map<String, Object> scopeMap = getScopeMap(entity);
@@ -97,7 +107,7 @@ private static Map<String, Object> getScopeMap(InstrumentationEntity entity) {
   }
 
   public static InstrumentationMetaData metaDataParser(String input) {
-    return new Yaml().loadAs(input, InstrumentationMetaData.class);
+    return metaDataYaml.loadAs(input, InstrumentationMetaData.class);
   }
 
   private YamlHelper() {}

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/utils/YamlHelper.java

@@ -69,9 +69,9 @@ void testPrintInstrumentationList() throws Exception {
               instrumentations:
               - name: spring-web-6.0
                 description: Spring Web 6.0 instrumentation
-                disabledByDefault: true
-                srcPath: instrumentation/spring/spring-web/spring-web-6.0
-                minimumJavaVersion: 11
+                disabled_by_default: true
+                source_path: instrumentation/spring/spring-web/spring-web-6.0
+                minimum_java_version: 11
                 scope:
                   name: io.opentelemetry.spring-web-6.0
                 target_versions:
@@ -80,7 +80,7 @@ void testPrintInstrumentationList() throws Exception {
             struts:
               instrumentations:
               - name: struts-2.3
-                srcPath: instrumentation/struts/struts-2.3
+                source_path: instrumentation/struts/struts-2.3
                 scope:
                   name: io.opentelemetry.struts-2.3
                 target_versions:
@@ -137,8 +137,8 @@ void testPrintInstrumentationListIgnoresNonLibraryInstrumentation() throws Excep
               instrumentations:
               - name: spring-web-6.0
                 description: Spring Web 6.0 instrumentation
-                srcPath: instrumentation/spring/spring-web/spring-web-6.0
-                minimumJavaVersion: 11
+                source_path: instrumentation/spring/spring-web/spring-web-6.0
+                minimum_java_version: 11
                 scope:
                   name: io.opentelemetry.spring-web-6.0
                 target_versions:
@@ -155,7 +155,7 @@ void testMetadataParser() {
         """
         description: test description
         isLibraryInstrumentation: false
-        disabledByDefault: true
+        disabled_by_default: true
         """;
 
     InstrumentationMetaData metadata = YamlHelper.metaDataParser(input);
@@ -183,7 +183,7 @@ void testMetadataParserWithOnlyDescription() {
 
   @Test
   void testMetadataParserWithOnlyDisabledByDefault() {
-    String input = "disabledByDefault: true";
+    String input = "disabled_by_default: true";
     InstrumentationMetaData metadata = YamlHelper.metaDataParser(input);
     assertThat(metadata.getIsLibraryInstrumentation()).isTrue();
     assertThat(metadata.getDescription()).isNull();

instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/utils/YamlHelperTest.java

@@ -1 +1 @@
-disabledByDefault: true
+disabled_by_default: true

instrumentation/dropwizard/dropwizard-metrics-4.0/metadata.yaml

@@ -1 +1 @@
-disabledByDefault: true
+disabled_by_default: true

instrumentation/jaxrs/jaxrs-1.0/metadata.yaml

@@ -1 +1 @@
-disabledByDefault: true
+disabled_by_default: true

instrumentation/jaxrs/jaxrs-2.0/metadata.yaml

@@ -1 +1 @@
-disabledByDefault: true
+disabled_by_default: true

instrumentation/jaxrs/jaxrs-3.0/metadata.yaml

@@ -1 +1 @@
-disabledByDefault: true
+disabled_by_default: true