added features table

AlexanderWert · AlexanderWert · commit 0d2ef97f63f6 · 2025-03-13T17:17:00.000+01:00
Signed-off-by: Alexander Wert &lt;alexander.wert@elastic.co&gt;
diff --git a/.github/workflows/check-md-generation.yml b/.github/workflows/check-md-generation.yml
@@ -18,7 +18,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.13'
+          python-version: '3.10'
       - name: Install dependencies
         run: |
           cd docs/gen_edot_col_components
diff --git a/docs/Makefile b/docs/Makefile
@@ -1,5 +1,5 @@
-.PHONY: generate-collector-components
-generate-collector-components: 
+.PHONY: generate
+generate: 
 	cd gen_edot_col_components && pip install -r requirements.txt && python3 render_md.py
 
 .PHONY: check-md-gen
@@ -19,5 +19,5 @@ check-links: build-site
 	bundle exec htmlproofer --assume_extension '.html' --swap-urls '^/opentelemetry/:/' --ignore_urls '/http:\/\/localhost:4000.*/','/https:\/\/elastic.github.io\/opentelemetry\/*/','/https:\/\/mvnrepository.com\/artifact\/co.elastic.otel\/elastic-otel-javaagent.*/' --no_enforce_https ./_site
 
 .PHONY: run-local
-run-local: generate-collector-components
+run-local: generate
 	bundle exec jekyll serve
diff --git a/docs/_edot-collector/components.md b/docs/_edot-collector/components.md
@@ -10,6 +10,7 @@ parent: Customization
 The EDOT Collector comes with embedded Collector components from the [OTel Collector Core](https://github.com/open-telemetry/opentelemetry-collector), 
 [OTel Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib) and the [Elastic Collector Components](https://github.com/elastic/opentelemetry-collector-components) repositories. 
 
+<!-- DO NOT DELETE THIS SECTION, TAGS ARE REQUIRED FOR GENERATION-->
 <!-- start:edot-collector-components-table -->
 
 | Component | GitHub Repo | Version |
diff --git a/docs/_edot-sdks/android/index.md b/docs/_edot-sdks/android/index.md
@@ -1,7 +1,7 @@
 ---
 title: EDOT Android
 layout: default
-nav_order: 2
+nav_order: 7
 ---
 
 ## EDOT Android
diff --git a/docs/_edot-sdks/dotnet/index.md b/docs/_edot-sdks/dotnet/index.md
@@ -1,7 +1,7 @@
 ---
 title: EDOT .NET
 layout: default
-nav_order: 5
+nav_order: 2
 ---
 
 ## EDOT .NET
diff --git a/docs/_edot-sdks/index.md b/docs/_edot-sdks/index.md
@@ -26,7 +26,7 @@ Currently, the following EDOT SDKs are availble:
 
 For languages for which Elastic does not offer its own distribution, we recommend using the upstream OTel SDKs:
 
-| Language | Release Status |
+| Language | Upstream Docs |
 |:-------------------|:---------------|
 | JS / Browser | [Vanilla OTel RUM SDK/API](https://opentelemetry.io/docs/languages/js/) |
 | Rust       | [Vanilla OTel Rust SDK/API](https://opentelemetry.io/docs/languages/rust/) |
diff --git a/docs/_edot-sdks/ios/index.md b/docs/_edot-sdks/ios/index.md
@@ -1,7 +1,7 @@
 ---
 title: EDOT iOS
 layout: default
-nav_order: 5
+nav_order: 8
 ---
 
 ## EDOT iOS
diff --git a/docs/_edot-sdks/java/index.md b/docs/_edot-sdks/java/index.md
@@ -1,7 +1,7 @@
 ---
 title: EDOT Java
 layout: default
-nav_order: 5
+nav_order: 3
 ---
 
 ## EDOT Java
diff --git a/docs/_edot-sdks/nodejs/index.md b/docs/_edot-sdks/nodejs/index.md
@@ -1,7 +1,7 @@
 ---
 title: EDOT Node.js
 layout: default
-nav_order: 5
+nav_order: 4
 ---
 
 ## EDOT Node.js
diff --git a/docs/_edot-sdks/python/index.md b/docs/_edot-sdks/python/index.md
@@ -1,7 +1,7 @@
 ---
 title: EDOT Python
 layout: default
-nav_order: 5
+nav_order: 6
 ---
 
 ## EDOT Python
diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss
@@ -0,0 +1,75 @@
+/* ---- Features Table ------ */
+
+table.features-table {
+    min-width: unset !important;
+    max-width: 43rem;
+}
+
+
+table.features-table th {
+    min-width: unset !important;
+}
+
+table.features-table td.s {
+    min-width: 35px;
+}
+
+table.features-table th.r {
+    height: 60px;
+    white-space: nowrap;
+    border-left: none;
+}
+  
+table.features-table th.r > div {
+    transform: 
+        translate(7px, -2px)
+        rotate(315deg);
+
+    border-bottom: 1px solid #ccc;
+    min-width: 70px;
+    text-align: start;
+}
+
+table.features-table th.f {
+    vertical-align: bottom;
+    text-align: left;
+}
+
+table.features-table td.f {
+    width: 100%;
+}
+
+table.features-table th.l {
+    width: 100%;
+    border: unset;
+}
+
+table.features-table .s {
+    max-width: 35px;
+}
+
+table.features-table td.s {
+    padding: unset !important;
+    text-align: center;
+}
+
+table.features-table td.b {
+    border-right: 1px solid #eeebee;
+    min-width: 38px !important;
+    max-width: 38px;
+}
+
+table.features-table th.l > div {
+    display: flex;
+    justify-content: space-between; /* Distributes items evenly */
+    width: 100%;
+    flex-direction: row;
+}
+
+table.features-table th.l > div > div {
+    flex: 1; /* Allows items to grow equally */
+    text-align: center; /* Centers text within each item */
+    padding: 5px; /* Adjust padding as needed */
+  }
+
+/* ------------------------ */
diff --git a/docs/gen_edot_col_components/requirements.txt b/docs/gen_edot_col_components/requirements.txt
@@ -1 +1,2 @@
 Jinja2==3.1.6
+PyYAML==6.0
diff --git a/docs/gen_edot_col_components/templates/features.jinja2 b/docs/gen_edot_col_components/templates/features.jinja2
@@ -0,0 +1,58 @@
+{%- macro icon(value) -%}
+{%- if value == "supported" -%}
+✅
+{%- elif value == "not-supported" -%}
+❌
+{%- elif value == "not-applicable" -%}
+➖
+{%- elif value == "tech-preview" -%}
+𝐓
+{%- else %}
+{%- endif -%}
+{%- endmacro %}
+{% macro title(feature) -%}
+{%- if 'link' in feature and feature['link'] -%}
+<a href="{{ feature['link'] }}">{{ feature['name'] }}</a>
+{%- else -%}
+{{ feature['name'] }}
+{%- endif -%}
+{%- endmacro -%}
+<table class="features-table"> 
+    <thead>
+        <tr> 
+            <th class="l" colspan="8">
+                <div>
+                    <div>✅ supported</div>
+                    <div>𝐓 in technical preview</div>
+                    <div>➖ not applicable</div>
+                    <div>❌ not supported</div>
+                </div>
+            </th> 
+        </tr>
+        <tr> 
+            <th class="f"><div>Feature</div></th> 
+            <th class="r s"><div>.NET </div></th> 
+            <th class="r s"><div>Java</div></th> 
+            <th class="r s"><div>Node.js</div></th> 
+            <th class="r s"><div>PHP</div></th> 
+            <th class="r s"><div>Python</div></th> 
+            <th class="r s"><div>Android</div></th> 
+            <th class="r s"><div>iOS</div></th> 
+        </tr> 
+    </thead> 
+    <tbody>
+{%- for feature in features %}
+        <!-- Feature: {{ feature['name'] }} -->
+        <tr>
+            <td class="f">{{ title(feature) }}</td> 
+            <td class="s">{{ icon(feature['dotnet']) }}</td> <!-- .NET -->
+            <td class="s">{{ icon(feature['java']) }}</td> <!-- Java -->
+            <td class="s">{{ icon(feature['nodejs']) }}</td> <!-- Node.js -->
+            <td class="s">{{ icon(feature['php']) }}</td> <!-- PHP -->
+            <td class="s">{{ icon(feature['python']) }}</td> <!-- Python -->
+            <td class="s">{{ icon(feature['android']) }}</td> <!-- Android -->
+            <td class="s b">{{ icon(feature['ios']) }}</td> <!-- iOS -->
+        </tr>
+{%- endfor %}
+    </tbody> 
+</table>
diff --git a/docs/gen_edot_col_components/tools.py b/docs/gen_edot_col_components/tools.py
@@ -1,14 +1,13 @@
 from jinja2 import Environment, FileSystemLoader
 import urllib.request
 from collections import defaultdict
-import re
-
-import os
+import yaml
 import re
 from pathlib import Path
 
 TABLE_TAG = 'edot-collector-components-table'
 DEPS_TAG = 'edot-collector-components-ocb'
+FEATURES_TAG = 'edot-features'
 
 def fetch_url_content(url):
     try:
@@ -113,24 +112,19 @@ def find_files_with_substring(directory, substring):
                 print(f"Skipping {file_path}: {e}")
     return matching_files
 
-def render_markdown(components, otel_col_version, template):
+def render_markdown(data, template):
     # Set up the Jinja2 environment
     env = Environment(loader=FileSystemLoader('.'))
 
     # Load the template
     template = env.get_template(template)
 
     # Define the data to pass to the template
-    data = {
-        'grouped_components': components,
-        'otel_col_version': otel_col_version
-    }
 
     return template.render(data)
 
-def render_components_into_file(dir, components, otel_col_version, template, tag):    
-    
-    output = render_markdown(components, otel_col_version, template)
+def render_components_into_file(dir, data, template, tag):    
+    output = render_markdown(data, template)
     start_tag = f'<!-- start:{tag} -->'
     end_tag = f'<!-- end:{tag} -->'
     
@@ -147,8 +141,8 @@ def render_components_into_file(dir, components, otel_col_version, template, tag
         with open(filePath, 'w', encoding='utf-8') as file:
             file.write(updated_content)   
 
-def check_markdown_generation(dir, components, otel_col_version, template, tag):
-    output = render_markdown(components, otel_col_version, template)
+def check_markdown_generation(dir, data, template, tag):
+    output = render_markdown(data, template)
     start_tag = f'<!-- start:{tag} -->'
     end_tag = f'<!-- end:{tag} -->'
     
@@ -164,25 +158,46 @@ def check_markdown_generation(dir, components, otel_col_version, template, tag):
         
         for match in matches:
             if match.strip() != output.strip():
-                print(f'Warning: Generated markdown for collector components is outdated in file {filePath}! Regenerate markdown by running `make generate-collector-components`!')
+                print(f'Warning: Generated markdown is outdated in file {filePath}! Regenerate markdown by running `make generate-collector-components`!')
                 return False;
             
     return True;
 
+def get_features_data(source_file):
+    with open(source_file, 'r') as file:
+        try:
+            return yaml.safe_load(file)
+        except yaml.YAMLError as exc:
+            print(f"Error reading YAML file: {exc}")
+            exit(1)
+
 def check_markdown():
     col_version = get_collector_version('../_config.yml')
     url = f'https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v{col_version}/go.mod'
     components = get_otel_components(url)
     otel_col_version = get_otel_col_upstream_version(url)
-    tables = check_markdown_generation('../_edot-collector', components, otel_col_version, 'templates/components-table.jinja2', TABLE_TAG) 
+    data = {
+        'grouped_components': components,
+        'otel_col_version': otel_col_version
+    }
+    tables = check_markdown_generation('../_edot-collector', data, 'templates/components-table.jinja2', TABLE_TAG) 
+    ocb = check_markdown_generation('../_edot-collector', data, 'templates/ocb.jinja2', DEPS_TAG)
     
-    ocb = check_markdown_generation('../_edot-collector', components, otel_col_version, 'templates/ocb.jinja2', DEPS_TAG)
-    return tables and ocb
+    features_data = get_features_data('../use-cases/features.yml')
+    features = check_markdown_generation('../use-cases', features_data, 'templates/features.jinja2', FEATURES_TAG)
+    return tables and ocb and features
 
 def generate_markdown():
     col_version = get_collector_version('../_config.yml')
     url = f'https://raw.githubusercontent.com/elastic/elastic-agent/refs/tags/v{col_version}/go.mod'
     components = get_otel_components(url)
     otel_col_version = get_otel_col_upstream_version(url)
-    render_components_into_file('../_edot-collector', components, otel_col_version, 'templates/components-table.jinja2', TABLE_TAG)
-    render_components_into_file('../_edot-collector', components, otel_col_version, 'templates/ocb.jinja2', DEPS_TAG)
+    data = {
+        'grouped_components': components,
+        'otel_col_version': otel_col_version
+    }
+    render_components_into_file('../_edot-collector', data, 'templates/components-table.jinja2', TABLE_TAG)
+    render_components_into_file('../_edot-collector', data, 'templates/ocb.jinja2', DEPS_TAG)
+    
+    features_data = get_features_data('../use-cases/features.yml')
+    render_components_into_file('../use-cases', features_data, 'templates/features.jinja2', FEATURES_TAG)
diff --git a/docs/quickstart/ech/hosts_vms.md b/docs/quickstart/ech/hosts_vms.md
@@ -17,7 +17,7 @@ The quick start for Hosts / VMs with with Elastic Cloud Hosted will guide you th
 
 1. **Download the EDOT Collector**
 
-    [Download the EDOT Collector](../../edot-collector/download) for your operating system.
+    [Download the EDOT Collector](../../edot-collector/download) for your operating system, extract the archive and move to the extracted directory.
 
 2. **Configure the EDOT Collector**
 
@@ -38,7 +38,7 @@ The quick start for Hosts / VMs with with Elastic Cloud Hosted will guide you th
     ```bash
     ELASTICSEARCH_ENDPOINT=<ELASTICSEARCH_ENDPOINT> \
     ELASTIC_API_KEY=<ELASTIC_API_KEY> \
-    rm ./otel.yml && cp ./otel_samples/logs_metrics_traces.yml ./otel.yml && mkdir -p ./data/otelcol && sed -i '' 's#\${env:STORAGE_DIR}#'"$PWD"/data/otelcol'#g' ./otel.yml && sed -i '' 's#\${env:ELASTIC_ENDPOINT}#$ELASTICSEARCH_ENDPOINT' ./otel.yml && sed -i '' 's/\${env:ELASTIC_API_KEY}/$ELASTIC_API_KEY/g' ./otel.yml
+    rm ./otel.yml && cp ./otel_samples/logs_metrics_traces.yml ./otel.yml && mkdir -p ./data/otelcol && sed -i '' 's#\${env:STORAGE_DIR}#'"$PWD"/data/otelcol'#g' ./otel.yml && sed -i '' 's#\${env:ELASTIC_ENDPOINT}#'"$ELASTICSEARCH_ENDPOINT"'#g' ./otel.yml && sed -i '' 's#\${env:ELASTIC_API_KEY}#'"$ELASTIC_API_KEY"'#g' ./otel.yml
     ```
 
     *Windows*
diff --git a/docs/quickstart/self-managed/hosts_vms.md b/docs/quickstart/self-managed/hosts_vms.md
@@ -17,7 +17,7 @@ The quick start for Hosts / VMs with a self-managed Elastic Stack will guide you
 
 1. **Download the EDOT Collector**
 
-    [Download the EDOT Collector](../../edot-collector/download) for your operating system.
+    [Download the EDOT Collector](../../edot-collector/download) for your operating system, extract the archive and move to the extracted directory.
 
 2. **Configure the EDOT Collector**
 
@@ -36,7 +36,7 @@ The quick start for Hosts / VMs with a self-managed Elastic Stack will guide you
     ```bash
     ELASTICSEARCH_ENDPOINT=<ELASTICSEARCH_ENDPOINT> \
     ELASTIC_API_KEY=<ELASTIC_API_KEY> \
-    rm ./otel.yml && cp ./otel_samples/logs_metrics_traces.yml ./otel.yml && mkdir -p ./data/otelcol && sed -i '' 's#\${env:STORAGE_DIR}#'"$PWD"/data/otelcol'#g' ./otel.yml && sed -i '' 's#\${env:ELASTIC_ENDPOINT}#$ELASTICSEARCH_ENDPOINT' ./otel.yml && sed -i '' 's/\${env:ELASTIC_API_KEY}/$ELASTIC_API_KEY/g' ./otel.yml
+    rm ./otel.yml && cp ./otel_samples/logs_metrics_traces.yml ./otel.yml && mkdir -p ./data/otelcol && sed -i '' 's#\${env:STORAGE_DIR}#'"$PWD"/data/otelcol'#g' ./otel.yml && sed -i '' 's#\${env:ELASTIC_ENDPOINT}#'"$ELASTICSEARCH_ENDPOINT"'#g' ./otel.yml && sed -i '' 's#\${env:ELASTIC_API_KEY}#'"$ELASTIC_API_KEY"'#g' ./otel.yml
     ```
 
     *Windows*
diff --git a/docs/use-cases/features.yml b/docs/use-cases/features.yml
diff --git a/docs/use-cases/index.md b/docs/use-cases/index.md
