Merge pull request #522 from ZhouBox/v2.10

[v2.10]add api about otel
emqx · Oct 12, 2024 · 1ddfd1d · 1ddfd1d
2 parents 3889949 + 38228ea
commit 1ddfd1d
Showing 1 changed file with 117 additions and 0 deletions.
diff --git a/neuron-api.json b/neuron-api.json
@@ -7333,6 +7333,123 @@
         },
         "x-run-in-apifox": "https://apifox.com/web/project/3516282/apis/api-123060905-run"
       }
+    },
+    "/api/neuron/otel": {
+      "get": {
+        "summary": "Get OTEL Trace Configuration",
+        "x-apifox-folder": "Neuron/trace",
+        "x-apifox-status": "released",
+        "deprecated": false,
+        "description": "Get OTEL Trace Configuration.",
+        "tags": [
+          "Neuron/trace"
+        ],
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "action": {
+                      "type": "string"
+                    },
+                    "collector_url": {
+                      "type": "string"
+                    },
+                    "control": {
+                      "type": "boolean"
+                    },
+                    "data": {
+                      "type": "boolean"
+                    },
+                    "data_sample_rate": {
+                      "type": "number",
+                      "format": "double"
+                    },
+                    "service_name": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-run-in-apifox": "https://apifox.com/web/project/3516282/apis/api-123060905-run"
+      },
+      "post": {
+        "summary": "Set OTEL Trace Configuration",
+        "x-apifox-folder": "Neuron/trace",
+        "x-apifox-status": "released",
+        "deprecated": false,
+        "description": "Set OTEL Trace Configuration.",
+        "tags": [
+          "Neuron/trace"
+        ],
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "action": {
+                    "type": "string"
+                  },
+                  "collector_url": {
+                    "type": "string"
+                  },
+                  "control": {
+                    "type": "boolean"
+                  },
+                  "data": {
+                    "type": "boolean"
+                  },
+                  "data_sample_rate": {
+                    "type": "number",
+                    "format": "double"
+                  },
+                  "service_name": {
+                    "type": "string"
+                  }
+                },
+                "example": {
+                  "action": "start",
+                  "collector_url": "127.0.0.1:4318",
+                  "control": true,
+                  "data": true,
+                  "data_sample_rate": 0.01,
+                  "service_name": "neuronex-001"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "success",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/neuron-0"
+                },
+                "examples": {
+                  "1": {
+                    "summary": "success",
+                    "value": {
+                      "error": 0
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-run-in-apifox": "https://apifox.com/web/project/3516282/apis/api-123060905-run"
+      }
     }
   },
   "components": {