Merge branch 'main' into legacy-dotnet-device

odigos-io · Jan 27, 2025 · f8d1e9b · f8d1e9b
2 parents 938b879 + 4484b04
commit f8d1e9b
Show file tree

Hide file tree

Showing 54 changed files with 861 additions and 352 deletions.
diff --git a/.github/workflows/backends-docs-sync.yaml b/.github/workflows/backends-docs-sync.yaml
diff --git a/.github/workflows/generated-docs.yaml b/.github/workflows/generated-docs.yaml
@@ -1,45 +1,92 @@
-name: Verify generated docs
+name: Verify Documentation Changes
 
 on:
   pull_request:
     branches:
       - main
 
 jobs:
-  check-api-doc-change:
+  check-crd-api-doc-change:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-
-      - name: Generate docs
+      - name: Generate CRD API docs
         run: |
-          cd api && make docgen
-
-      - name: Check for changes
+          cd api
+          make docgen
+      - name: Check for changes in CRD API docs
         run: |
           if [[ $(git diff --exit-code) ]]; then
             git diff
-            echo "CRD API docs need to be updated. Please run 'cd api && make docgen' and commit the changes."
+            echo "CRD API docs need to be updated. Please run 'cd api && make docgen', then commit the changes."
             exit 1
           fi
 
   check-cli-doc-change:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
-
-      - name: Generate docs
+      - name: Generate CLI docs
         run: |
           make cli-docs
+      - name: Check for changes in CLI docs
+        run: |
+          if [[ $(git diff --exit-code) ]]; then
+            git diff
+            echo "CLI docs need to be updated. Please run 'make cli-docs', then commit the changes."
+            exit 1
+          fi
+
+  check-destination-doc-change:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pyyaml
+      - name: Generate Destination docs
+        run: |
+          cd docs
+          python sync-dest-doc.py
+      - name: Check for changes in Destinations docs
+        run: |
+          if [[ $(git diff --exit-code) ]]; then
+            git diff
+            echo "Destinations docs need to be updated. Please run 'cd docs && python sync-dest-doc.py', then commit the changes."
+            exit 1
+          fi
 
-      - name: Check for changes
+  check-instrumentation-doc-change:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pyyaml
+          cd docs
+          yarn py-install-deps
+      - name: Generate Instrumentation docs
+        run: |
+          cd docs
+          python sync-instru-doc.py
+      - name: Check for changes in Instrumentation docs
         run: |
           if [[ $(git diff --exit-code) ]]; then
             git diff
-            echo "CLI docs need to be updated. Please run 'make cli-docs' and commit the changes."
+            echo "Instrumentation docs need to be updated. Pleaserun 'cd docs && python sync-instru-doc.py', then commit the changes."
             exit 1
           fi
diff --git a/cli/cmd/resources/README.md b/cli/cmd/resources/README.md
@@ -28,10 +28,10 @@ In this doc, we'll keep track of the permissions requested across different reso
 | Collector    | apps              | replicasets, deployments, daemonsets, statefulsets         | \*             | get, list                                       | Fetches application details for instrumentation.                                                                          |
 | Collector    | ""                | endpoints                                                  | \*             | get, list, watch                                | Needed for load balancer.                                                                                                 |
 | Collector    | policy            | podsecuritypolicies                                        | \*             | use                                             | Supports clients enabling pod security policies (optional).                                                               |
-| UI           | ""                | namespaces                                                 | \*             | get, list, patch                                | Needed to retrieve and instrument namespaces.                                                                             |
+| UI           | ""                | namespaces                                                 | \*             | get, list                                       | Needed to get namespaces.                                                                                                 |
 | UI           | ""                | services                                                   | \*             | get, list                                       | Required for discovering potential destinations and describing application workloads.                                     |
 | UI           | ""                | pods                                                       | \*             | get, list, watch                                | Required for discovering potential destinations and describing application workloads, and for updating collector metrics. |
-| UI           | apps              | deployments, statefulsets, daemonsets                      | \*             | get, list, patch, update                        | Required for instrumentation of application sources.                                                                      |
+| UI           | apps              | deployments, statefulsets, daemonsets                      | \*             | get, list                                       | Needed to get workloads.                                                                                                  |
 | UI           | apps              | replicasets                                                | \*             | get, list                                       | Needed for describing application and resource relationships.                                                             |
 | UI           | odigos.io         | instrumentationconfigs, instrumentationinstances           | \*             | get, list, watch                                | Monitors and retrieves configurations for instrumentation.                                                                |
 | UI           | odigos.io         | sources                                                    | \*             | get, list, create, delete                       | Manages sources for instrumentation and monitoring.                                                                       |

diff --git a/cli/cmd/resources/ui.go b/cli/cmd/resources/ui.go
@@ -279,12 +279,12 @@ func NewUIClusterRole(readonly bool) *rbacv1.ClusterRole {
 			{ // Needed to get and instrument namespaces
 				APIGroups: []string{""},
 				Resources: []string{"namespaces"},
-				Verbs:     []string{"get", "list", "patch"},
+				Verbs:     []string{"get", "list"},
 			},
-			{ // Needed to get and instrument sources
+			{ // Needed to get workloads
 				APIGroups: []string{"apps"},
 				Resources: []string{"deployments", "statefulsets", "daemonsets"},
-				Verbs:     []string{"get", "list", "patch", "update"},
+				Verbs:     []string{"get", "list"},
 			},
 			{ // Needed for "Describe Source" and for "Describe Odigos"
 				APIGroups: []string{"apps"},

diff --git a/docs/cli/odigos.mdx b/docs/cli/odigos.mdx
@@ -39,6 +39,4 @@ Get started with Odigos today to effortlessly improve the observability of your
 This command will uninstall Odigos from your cluster. It will delete all Odigos objects
 and rollback any metadata changes made to your objects.
 * [odigos upgrade](/cli/odigos_upgrade)	 - Upgrade odigos version in your cluster.
-* [odigos version](/cli/odigos_version)	 - Print odigos version.
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos version](/cli/odigos_version)	 - Print odigos version.
diff --git a/docs/cli/odigos_cloud.mdx b/docs/cli/odigos_cloud.mdx
@@ -49,6 +49,4 @@ odigos cloud logout
 * [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
 * [odigos cloud login](/cli/odigos_cloud_login)	 - Login to Odigos cloud
 * [odigos cloud logout](/cli/odigos_cloud_logout)	 - Logout from Odigos cloud
-* [odigos cloud update](/cli/odigos_cloud_update)	 - Update your Odigos Cloud api-key
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos cloud update](/cli/odigos_cloud_update)	 - Update your Odigos Cloud api-key
diff --git a/docs/cli/odigos_cloud_login.mdx b/docs/cli/odigos_cloud_login.mdx
@@ -30,6 +30,4 @@ odigos cloud login [flags]
 
 ### SEE ALSO
 
-* [odigos cloud](/cli/odigos_cloud)	 - Manage the connection of the cluster to Odigos cloud
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos cloud](/cli/odigos_cloud)	 - Manage the connection of the cluster to Odigos cloud
diff --git a/docs/cli/odigos_cloud_logout.mdx b/docs/cli/odigos_cloud_logout.mdx
@@ -34,6 +34,4 @@ odigos cloud logout [flags]
 
 ### SEE ALSO
 
-* [odigos cloud](/cli/odigos_cloud)	 - Manage the connection of the cluster to Odigos cloud
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos cloud](/cli/odigos_cloud)	 - Manage the connection of the cluster to Odigos cloud
diff --git a/docs/cli/odigos_cloud_update.mdx b/docs/cli/odigos_cloud_update.mdx
@@ -31,6 +31,4 @@ odigos cloud update [flags]
 
 ### SEE ALSO
 
-* [odigos cloud](/cli/odigos_cloud)	 - Manage the connection of the cluster to Odigos cloud
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos cloud](/cli/odigos_cloud)	 - Manage the connection of the cluster to Odigos cloud
diff --git a/docs/cli/odigos_describe.mdx b/docs/cli/odigos_describe.mdx
@@ -80,6 +80,4 @@ Pods (Total 1, Running 1):
 ### SEE ALSO
 
 * [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
-* [odigos describe source](/cli/odigos_describe_source)	 - Show details of a specific odigos source
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos describe source](/cli/odigos_describe_source)	 - Show details of a specific odigos source
diff --git a/docs/cli/odigos_describe_source.mdx b/docs/cli/odigos_describe_source.mdx
@@ -30,6 +30,4 @@ Print detailed description of a specific odigos source, which can be used to tro
 * [odigos describe](/cli/odigos_describe)	 - Show details of a specific odigos entity
 * [odigos describe source daemonset](/cli/odigos_describe_source_daemonset)	 - Show details of a specific odigos source of type daemonset
 * [odigos describe source deployment](/cli/odigos_describe_source_deployment)	 - Show details of a specific odigos source of type deployment
-* [odigos describe source statefulset](/cli/odigos_describe_source_statefulset)	 - Show details of a specific odigos source of type statefulset
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos describe source statefulset](/cli/odigos_describe_source_statefulset)	 - Show details of a specific odigos source of type statefulset
diff --git a/docs/cli/odigos_describe_source_daemonset.mdx b/docs/cli/odigos_describe_source_daemonset.mdx
@@ -31,6 +31,4 @@ odigos describe source daemonset <name> [flags]
 
 ### SEE ALSO
 
-* [odigos describe source](/cli/odigos_describe_source)	 - Show details of a specific odigos source
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos describe source](/cli/odigos_describe_source)	 - Show details of a specific odigos source
diff --git a/docs/cli/odigos_describe_source_deployment.mdx b/docs/cli/odigos_describe_source_deployment.mdx
@@ -31,6 +31,4 @@ odigos describe source deployment <name> [flags]
 
 ### SEE ALSO
 
-* [odigos describe source](/cli/odigos_describe_source)	 - Show details of a specific odigos source
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos describe source](/cli/odigos_describe_source)	 - Show details of a specific odigos source
diff --git a/docs/cli/odigos_describe_source_statefulset.mdx b/docs/cli/odigos_describe_source_statefulset.mdx
@@ -31,6 +31,4 @@ odigos describe source statefulset <name> [flags]
 
 ### SEE ALSO
 
-* [odigos describe source](/cli/odigos_describe_source)	 - Show details of a specific odigos source
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos describe source](/cli/odigos_describe_source)	 - Show details of a specific odigos source
diff --git a/docs/cli/odigos_diagnose.mdx b/docs/cli/odigos_diagnose.mdx
@@ -31,6 +31,4 @@ odigos diagnose [flags]
 
 ### SEE ALSO
 
-* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
diff --git a/docs/cli/odigos_install.mdx b/docs/cli/odigos_install.mdx
@@ -65,6 +65,4 @@ odigos install --onprem-token ${ODIGOS_TOKEN} --profile ${YOUR_ENTERPRISE_PROFIL
 
 ### SEE ALSO
 
-* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
diff --git a/docs/cli/odigos_pro.mdx b/docs/cli/odigos_pro.mdx
@@ -31,6 +31,4 @@ odigos pro [flags]
 
 ### SEE ALSO
 
-* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
diff --git a/docs/cli/odigos_profile.mdx b/docs/cli/odigos_profile.mdx
@@ -44,6 +44,4 @@ odigos profile remove full-payload-collection
 
 * [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
 * [odigos profile add](/cli/odigos_profile_add)	 - Add a profile to the current Odigos installation
-* [odigos profile remove](/cli/odigos_profile_remove)	 - Remove a profile from the current Odigos installation
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos profile remove](/cli/odigos_profile_remove)	 - Remove a profile from the current Odigos installation
diff --git a/docs/cli/odigos_profile_add.mdx b/docs/cli/odigos_profile_add.mdx
@@ -29,6 +29,4 @@ odigos profile add <profile_name> [flags]
 
 ### SEE ALSO
 
-* [odigos profile](/cli/odigos_profile)	 - Manage presets of applied profiles to your odigos installation
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos profile](/cli/odigos_profile)	 - Manage presets of applied profiles to your odigos installation
diff --git a/docs/cli/odigos_profile_remove.mdx b/docs/cli/odigos_profile_remove.mdx
@@ -29,6 +29,4 @@ odigos profile remove <profile_name> [flags]
 
 ### SEE ALSO
 
-* [odigos profile](/cli/odigos_profile)	 - Manage presets of applied profiles to your odigos installation
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos profile](/cli/odigos_profile)	 - Manage presets of applied profiles to your odigos installation
diff --git a/docs/cli/odigos_ui.mdx b/docs/cli/odigos_ui.mdx
@@ -46,6 +46,4 @@ odigos ui --kubeconfig <path-to-kubeconfig>
 
 ### SEE ALSO
 
-* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
diff --git a/docs/cli/odigos_uninstall.mdx b/docs/cli/odigos_uninstall.mdx
@@ -47,6 +47,4 @@ odigos install
 
 ### SEE ALSO
 
-* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
diff --git a/docs/cli/odigos_upgrade.mdx b/docs/cli/odigos_upgrade.mdx
@@ -44,6 +44,4 @@ odigos upgrade
 
 ### SEE ALSO
 
-* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
diff --git a/docs/cli/odigos_version.mdx b/docs/cli/odigos_version.mdx
@@ -41,6 +41,4 @@ odigos version
 
 ### SEE ALSO
 
-* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
-
-###### Auto generated by spf13/cobra on 26-Jan-2025
+* [odigos](/cli/odigos)	 - Automate OpenTelemetry Observability in Kubernetes
diff --git a/docs/instrumentations/dotnet/native.mdx b/docs/instrumentations/dotnet/native.mdx
@@ -35,7 +35,7 @@ The following .NET modules will be auto instrumented by Odigos:
 |----------------------------------------------------------------------------------------------------|-----------------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | [Microsoft.Data.SqlClient](https://www.nuget.org/packages/Microsoft.Data.SqlClient)                | Yes             |       |                                                                                                                                                                              |
 | [System.Data.SqlClient](https://www.nuget.org/packages/System.Data.SqlClient)                      | Yes             |       |                                                                                                                                                                              |
-| [MySql.Data](https://dev.mysql.com/doc/connector-net/en/connector-net-introduction.html)           | Partial         |       | This is the official [MySQL](https://dev.mysql.com/) library.                                                                                                                |
+| MySql.Data           | Partial         |       | This is the official MySQL library.                                                                                                                |
 | [MySqlConnector](https://mysqlconnector.net/)                                                      | Yes             |       | Seems to be the [recommended library for MariaDB](https://mariadb.com/kb/en/mysqlconnector-for-ado-net/).                                                                    |
 | [Npgsql](https://www.npgsql.org/)                                                                  | Yes             |       |                                                                                                                                                                              |
 | [Microsoft.Data.SqlLite](https://docs.microsoft.com/dotnet/standard/data/sqlite/?tabs=netcore-cli) |                 |       |                                                                                                                                                                              |

diff --git a/docs/instrumentations/nodejs/enrichment.mdx b/docs/instrumentations/nodejs/enrichment.mdx
@@ -17,9 +17,8 @@ npm install @opentelemetry/[email protected]
 ```
 
 <Warning>
-Odigos agent implements OpenTelemetry API version 1.9.0. Any version greater than 1.9.0 may not be compatible with Odigos agent and fail to produce data.
-
-Please do not use caret range ~~`@opentelemetry/api@^1.9.0`~~ for this dependency in your package.json to avoid pulling in incompatible version.
+  Odigos agent implements OpenTelemetry API version 1.9.0. Any version greater than 1.9.0 may not be compatible with Odigos agent and fail to produce data.<br />
+  Please do not use caret range ~~`@opentelemetry/api@^1.9.0`~~ for this dependency in your package.json to avoid pulling in incompatible version.
 </Warning>
 
 ## Creating Spans