+# Examples: +#
+# "PT20.345S" -- parses as "20.345 seconds" +# "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) +# "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) +# "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds) +# "P2DT3H4M" -- parses as "2 days, 3 hours and 4 minutes" +# "P-6H3M" -- parses as "-6 hours and +3 minutes" +# "-P6H3M" -- parses as "-6 hours and -3 minutes" +# "-P-6H+3M" -- parses as "+6 hours and -3 minutes" +#+# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This will parse a textual representation of a duration. The formats +# accepted are based on the ISO-8601 duration format {@code PnDTnHnMn.nS} +# with days considered to be exactly 24 hours. +#
+# Examples: +#
+# "PT20.345S" -- parses as "20.345 seconds" +# "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) +# "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) +# "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds) +# "P2DT3H4M" -- parses as "2 days, 3 hours and 4 minutes" +# "P-6H3M" -- parses as "-6 hours and +3 minutes" +# "-P6H3M" -- parses as "-6 hours and -3 minutes" +# "-P-6H+3M" -- parses as "+6 hours and -3 minutes" +#+filter: "{ tags -> tags.job_name == 'kong-monitoring' }" +expSuffix: tag({tags -> tags.host_name = 'kong::' + tags.host_name}).instance(['host_name'], ['service_instance_id'], Layer.KONG) +metricPrefix: meter_kong_instance +metricsRules: + # counter + # Total bandwidth (ingress/egress) throughput in bytes + - name: http_bandwidth + exp: kong_bandwidth_bytes.sum(['host_name','service_instance_id','direction','route']).rate('PT1M') + # HTTP status codes per consumer/service/route in Kong + - name: http_status + exp: kong_http_requests_total.sum(['host_name','service_instance_id','code']).rate('PT1M') + + # gauge + # Datastore reachable from Kong + - name: datastore_reachable + exp: kong_datastore_reachable.sum(['host_name','service_instance_id']) + # Total number of requests + - name: http_requests + exp: kong_nginx_requests_total.sum(['host_name','service_instance_id']).rate('PT1M') + # Allocated slabs in bytes in a shared_dict + - name: shared_dict_bytes + exp: kong_memory_lua_shared_dict_bytes.sum(['host_name','service_instance_id','shared_dict']) + # Total capacity in bytes of a shared_dict + - name: shared_dict_total_bytes + exp: kong_memory_lua_shared_dict_total_bytes.sum(['host_name','service_instance_id','shared_dict']) + # Allocated bytes in worker Lua VM + - name: memory_workers_lua_vms_bytes + exp: kong_memory_workers_lua_vms_bytes.tagNotEqual('pid','').sum(['host_name','service_instance_id','pid']) + # Number of connections by subsystem + - name: nginx_connections_total + exp: kong_nginx_connections_total.tagNotEqual('state','').sum(['host_name','service_instance_id','state']).rate('PT1M') + # Number of Nginx timers + - name: nginx_timers + exp: kong_nginx_timers.sum(['host_name','service_instance_id','state']) + + # histogram + # Latency added by Kong and enabled plugins for each service/route in Kong + - name: kong_latency + exp: kong_kong_latency_ms.sum(['host_name','service_instance_id','le']).histogram().histogram_percentile([50,70,90,99]) + # Total latency incurred during requests for each service/route in Kong + - name: request_latency + exp: kong_request_latency_ms.sum(['host_name','service_instance_id','le']).histogram().histogram_percentile([50,70,90,99]) + # Latency added by upstream response for each service/route in Kong + - name: upstream_latency + exp: kong_upstream_latency_ms.sum(['host_name','service_instance_id','le']).histogram().histogram_percentile([50,70,90,99]) \ No newline at end of file diff --git a/oap-server/server-starter/src/main/resources/otel-rules/kong/kong-service.yaml b/oap-server/server-starter/src/main/resources/otel-rules/kong/kong-service.yaml new file mode 100644 index 0000000000..028c8b445b --- /dev/null +++ b/oap-server/server-starter/src/main/resources/otel-rules/kong/kong-service.yaml @@ -0,0 +1,69 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This will parse a textual representation of a duration. The formats +# accepted are based on the ISO-8601 duration format {@code PnDTnHnMn.nS} +# with days considered to be exactly 24 hours. +#
+# Examples: +#
+# "PT20.345S" -- parses as "20.345 seconds" +# "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) +# "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) +# "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds) +# "P2DT3H4M" -- parses as "2 days, 3 hours and 4 minutes" +# "P-6H3M" -- parses as "-6 hours and +3 minutes" +# "-P6H3M" -- parses as "-6 hours and -3 minutes" +# "-P-6H+3M" -- parses as "+6 hours and -3 minutes" +#+filter: "{ tags -> tags.job_name == 'kong-monitoring' }" +expSuffix: tag({tags -> tags.host_name = 'kong::' + tags.host_name}).service(['host_name'], Layer.KONG) +metricPrefix: meter_kong_service +metricsRules: + # counter + # Total bandwidth (ingress/egress) throughput in bytes + - name: http_bandwidth + exp: kong_bandwidth_bytes.sum(['host_name','service_instance_id','direction','route']).rate('PT1M') + # HTTP status codes per consumer/service/route in Kong + - name: http_status + exp: kong_http_requests_total.sum(['host_name','service_instance_id','code']).rate('PT1M') + # Number of nginx-lua-prometheus errors + - name: nginx_metric_errors_total + exp: kong_nginx_metric_errors_total.sum(['host_name','service_instance_id']) + + # gauge + # Datastore reachable from Kong + - name: datastore_reachable + exp: kong_datastore_reachable.sum(['host_name','service_instance_id']) + # Total number of requests + - name: http_requests + exp: kong_nginx_requests_total.sum(['host_name','service_instance_id']).rate('PT1M') + # Number of connections by subsystem + - name: nginx_connections_total + exp: kong_nginx_connections_total.sum(['host_name','service_instance_id','state']).rate('PT1M') + # Number of Nginx timers + - name: nginx_timers + exp: kong_nginx_timers.sum(['host_name','service_instance_id','state']) + + # histogram + # Latency added by Kong and enabled plugins for each service/route in Kong + - name: kong_latency + exp: kong_kong_latency_ms.sum(['le','host_name','service_instance_id']).histogram().histogram_percentile([50,70,90,99]) + # Total latency incurred during requests for each service/route in Kong + - name: request_latency + exp: kong_request_latency_ms.sum(['le','host_name','service_instance_id']).histogram().histogram_percentile([50,70,90,99]) + # Latency added by upstream response for each service/route in Kong + - name: upstream_latency + exp: kong_upstream_latency_ms.sum(['le','host_name','service_instance_id']).histogram().histogram_percentile([50,70,90,99]) \ No newline at end of file diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-endpoint.json b/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-endpoint.json new file mode 100644 index 0000000000..008cea5b90 --- /dev/null +++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-endpoint.json @@ -0,0 +1,157 @@ +[ + { + "id": "Kong-Endpoint", + "configuration": { + "children": [ + { + "x": 0, + "y": 0, + "w": 12, + "h": 13, + "i": "0", + "type": "Widget", + "widget": { + "title": "Total bandwidth Trend (ingress/egress) (KB/s)" + }, + "metricConfig": [ + { + "label": "HTTP bandwidth Trend (requests per second)", + "unit": "KB/s" + } + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "expressions": [ + "meter_kong_endpoint_http_bandwidth/1024" + ] + }, + { + "x": 12, + "y": 0, + "w": 12, + "h": 13, + "i": "1", + "type": "Widget", + "widget": { + "title": "HTTP Status Trend (requests per second)" + }, + "metricConfig": [ + { + "label": "HTTP Status Trend", + "unit": "req/s" + } + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "expressions": [ + "meter_kong_endpoint_http_status" + ] + }, + { + "x": 0, + "y": 13, + "w": 8, + "h": 13, + "i": "2", + "type": "Widget", + "expressions": [ + "meter_kong_endpoint_kong_latency" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Kong Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Kong Latency", + "tips": "Latency added by Kong and enabled plugins for each service/route in Kong" + } + ] + }, + { + "x": 8, + "y": 13, + "w": 8, + "h": 13, + "i": "3", + "type": "Widget", + "expressions": [ + "meter_kong_endpoint_request_latency" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Request Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Request Latency", + "tips": "Total latency incurred during requests for each service/route in Kong" + } + ] + }, + { + "x": 16, + "y": 13, + "w": 8, + "h": 13, + "i": "4", + "type": "Widget", + "expressions": [ + "meter_kong_endpoint_upstream_latency" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Upstream Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Upstream Latency", + "tips": "Latency added by upstream response for each service/route in Kong" + } + ] + } + ], + "layer": "KONG", + "entity": "Endpoint", + "name": "Kong-Endpoint", + "isRoot": false, + "isDefault": true + } + } +] diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-instance.json b/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-instance.json new file mode 100644 index 0000000000..5099146a22 --- /dev/null +++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-instance.json @@ -0,0 +1,324 @@ +[ + { + "id": "Kong-Instance", + "configuration": { + "children": [ + { + "x": 0, + "y": 0, + "w": 12, + "h": 13, + "i": "0", + "type": "Widget", + "expressions": [ + "latest(meter_kong_instance_datastore_reachable)" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true, + "decorations": { + "0": "unreachable", + "1": "reachable" + } + }, + "metricConfig": [ + { + "label": "Datastore reachable" + } + ], + "widget": { + "title": "Datastore reachable", + "tips": "Datastore reachable from Kong, 0 is unreachable" + } + }, + { + "x": 12, + "y": 0, + "w": 12, + "h": 13, + "i": "1", + "type": "Widget", + "widget": { + "title": "Total bandwidth Trend (ingress/egress) (KB/s)" + }, + "metricConfig": [ + { + "label": "HTTP bandwidth Trend (requests per second)", + "unit": "KB/s" + } + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "expressions": [ + "meter_kong_instance_http_bandwidth/1024" + ] + }, + { + "x": 0, + "y": 13, + "w": 12, + "h": 13, + "i": "2", + "type": "Widget", + "widget": { + "title": "HTTP Status Trend (requests per second)" + }, + "metricConfig": [ + { + "label": "HTTP Status Trend", + "unit": "req/s" + } + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "expressions": [ + "meter_kong_instance_http_status" + ] + }, + { + "x": 12, + "y": 13, + "w": 12, + "h": 13, + "i": "3", + "type": "Widget", + "widget": { + "title": "HTTP Request Trend (requests per second)" + }, + "metricConfig": [ + { + "label": "Number of requests total" + } + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "expressions": [ + "meter_kong_instance_http_requests" + ] + }, + { + "x": 0, + "y": 26, + "w": 12, + "h": 13, + "i": "4", + "type": "Widget", + "expressions": [ + "(meter_kong_instance_shared_dict_bytes*100)/meter_kong_instance_shared_dict_total_bytes" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": false, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Shared memory usage (%)", + "tips": "Kong shared memory usage by Node (%)" + }, + "metricConfig": [ + { + "unit": "%", + "label": "Kong shared memory usage by Node (%)" + } + ] + }, + { + "x": 12, + "y": 26, + "w": 12, + "h": 13, + "i": "5", + "type": "Widget", + "expressions": [ + "meter_kong_instance_memory_workers_lua_vms_bytes/1024/1024" + ], + "graph": { + "type": "Area", + "opacity": 0.4, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Worker Lua VM usage by Node(MB)", + "tips": "Kong worker Lua VM usage by Node(MB)" + }, + "metricConfig": [ + { + "unit": "MB", + "label": "Kong worker Lua VM usage by Node" + } + ] + }, + { + "x": 0, + "y": 39, + "w": 12, + "h": 13, + "i": "6", + "type": "Widget", + "expressions": [ + "meter_kong_instance_nginx_connections_total" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "HTTP Connections Trend (requests per second)" + }, + "metricConfig": [ + { + "label": "HTTP Connections" + } + ] + }, + { + "x": 12, + "y": 39, + "w": 12, + "h": 13, + "i": "7", + "type": "Widget", + "expressions": [ + "meter_kong_instance_nginx_timers" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Nginx timers" + }, + "metricConfig": [ + { + "label": "Nginx timers" + } + ] + }, + { + "x": 0, + "y": 52, + "w": 8, + "h": 13, + "i": "8", + "type": "Widget", + "expressions": [ + "meter_kong_instance_kong_latency" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Kong Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Kong Latency", + "tips": "Latency added by Kong and enabled plugins for each service/route in Kong" + } + ] + }, + { + "x": 8, + "y": 52, + "w": 8, + "h": 13, + "i": "9", + "type": "Widget", + "expressions": [ + "meter_kong_instance_request_latency" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Request Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Request Latency", + "tips": "Total latency incurred during requests for each service/route in Kong" + } + ] + }, + { + "x": 16, + "y": 52, + "w": 8, + "h": 13, + "i": "10", + "type": "Widget", + "expressions": [ + "meter_kong_instance_upstream_latency" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Upstream Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Upstream Latency", + "tips": "Latency added by upstream response for each service/route in Kong" + } + ] + } + ], + "layer": "KONG", + "entity": "ServiceInstance", + "name": "Kong-Instance", + "isRoot": false, + "isDefault": true + } + } +] diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-root.json b/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-root.json new file mode 100644 index 0000000000..c5a6946c12 --- /dev/null +++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-root.json @@ -0,0 +1,45 @@ +[ + { + "id": "Kong-Root", + "configuration": { + "children": [ + { + "x": 0, + "y": 3, + "w": 24, + "h": 36, + "i": "0", + "type": "Widget", + "graph": { + "type": "ServiceList", + "dashboardName": "Kong-Service", + "fontSize": 12, + "showXAxis": false, + "showYAxis": false, + "showGroup": true + } + }, + { + "x": 0, + "y": 0, + "w": 24, + "h": 3, + "i": "1", + "type": "Text", + "graph": { + "fontColor": "theme", + "backgroundColor": "theme", + "content": "Provide Kong monitoring through OpenTelemetry's Prometheus Receiver", + "fontSize": 14, + "textAlign": "left", + "url": "https://skywalking.apache.org/docs/main/next/en/setup/backend/backend-kong-monitoring/" + } + } + ], + "layer": "KONG", + "entity": "All", + "name": "Kong-Root", + "isRoot": true + } + } +] diff --git a/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-service.json b/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-service.json new file mode 100644 index 0000000000..163eb1a4be --- /dev/null +++ b/oap-server/server-starter/src/main/resources/ui-initialized-templates/kong/kong-service.json @@ -0,0 +1,351 @@ +[ + { + "id": "Kong-Service", + "configuration": { + "children": [ + { + "x": 0, + "y": 0, + "w": 24, + "h": 48, + "i": "0", + "type": "Tab", + "children": [ + { + "name": "Inspections", + "children": [ + { + "x": 0, + "y": 0, + "w": 12, + "h": 8, + "i": "0", + "type": "Widget", + "expressions": [ + "latest(aggregate_labels(meter_kong_service_nginx_metric_errors_total,sum))" + ], + "graph": { + "type": "Card", + "fontSize": 24, + "textAlign": "center", + "showUnit": true + }, + "metricConfig": [ + { + "label": "Nginx metric errors" + } + ], + "widget": { + "title": "Nginx metric errors" + } + }, + { + "x": 12, + "y": 0, + "w": 12, + "h": 8, + "i": "1", + "type": "Widget", + "expressions": [ + "latest(aggregate_labels(meter_kong_service_datastore_reachable,sum(service_instance_id)))" + ], + "graph": { + "type": "Table", + "showTableValues": true, + "tableHeaderCol1": "Instances", + "tableHeaderCol2": "Reachable", + "decorations": { + "0": "unreachable", + "1": "reachable" + } + }, + "metricConfig": [ + { + "label": "Datastore reachable" + } + ], + "widget": { + "title": "Datastore reachable", + "tips": "Datastore reachable from Kong, 0 is unreachable" + } + }, + { + "x": 0, + "y": 8, + "w": 12, + "h": 13, + "i": "2", + "type": "Widget", + "widget": { + "title": "Total bandwidth Trend (ingress/egress) (KB/s)" + }, + "metricConfig": [ + { + "label": "HTTP bandwidth Trend (requests per second)", + "unit": "KB/s" + } + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "expressions": [ + "aggregate_labels(meter_kong_service_http_bandwidth,sum(direction))/1024" + ] + }, + { + "x": 12, + "y": 8, + "w": 12, + "h": 13, + "i": "3", + "type": "Widget", + "widget": { + "title": "HTTP Status Trend (requests per second)" + }, + "metricConfig": [ + { + "label": "HTTP Status Trend", + "unit": "req/s" + } + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "expressions": [ + "aggregate_labels(meter_kong_service_http_status,sum(code))" + ] + }, + { + "x": 0, + "y": 21, + "w": 12, + "h": 13, + "i": "4", + "type": "Widget", + "widget": { + "title": "HTTP Request Trend (requests per second)" + }, + "metricConfig": [ + { + "label": "Number of requests total", + "unit": "req/s" + } + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "expressions": [ + "aggregate_labels(meter_kong_service_http_requests,sum)" + ] + }, + { + "x": 12, + "y": 21, + "w": 12, + "h": 13, + "i": "5", + "type": "Widget", + "expressions": [ + "aggregate_labels(meter_kong_service_nginx_connections_total,sum(state))" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Nginx Connections Trend (requests per second)" + }, + "metricConfig": [ + { + "label": "Nginx Connections", + "unit": "req/s" + } + ] + }, + { + "x": 0, + "y": 34, + "w": 12, + "h": 13, + "i": "6", + "type": "Widget", + "expressions": [ + "aggregate_labels(meter_kong_service_nginx_timers,sum(state))" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Nginx timers" + }, + "metricConfig": [ + { + "label": "Nginx timers" + } + ] + }, + { + "x": 12, + "y": 34, + "w": 12, + "h": 13, + "i": "7", + "type": "Widget", + "expressions": [ + "aggregate_labels(meter_kong_service_kong_latency,avg(p))" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Kong Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Kong Latency", + "tips": "Latency added by Kong and enabled plugins for each service/route in Kong" + } + ] + }, + { + "x": 0, + "y": 47, + "w": 12, + "h": 13, + "i": "8", + "type": "Widget", + "expressions": [ + "aggregate_labels(meter_kong_service_request_latency,avg(p))" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Request Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Request Latency", + "tips": "Total latency incurred during requests for each service/route in Kong" + } + ] + }, + { + "x": 12, + "y": 47, + "w": 12, + "h": 13, + "i": "9", + "type": "Widget", + "expressions": [ + "aggregate_labels(meter_kong_service_upstream_latency,avg(p))" + ], + "graph": { + "type": "Line", + "step": false, + "smooth": false, + "showSymbol": true, + "showXAxis": true, + "showYAxis": true + }, + "widget": { + "title": "Upstream Latency", + "unit": "ms" + }, + "metricConfig": [ + { + "label": "Upstream Latency", + "tips": "Latency added by upstream response for each service/route in Kong" + } + ] + } + ] + }, + { + "name": "Instances", + "children": [ + { + "x": 0, + "y": 0, + "w": 24, + "h": 17, + "type": "Widget", + "graph": { + "type": "InstanceList", + "dashboardName": "Kong-Instance", + "fontSize": 12 + } + } + ] + } + ] + } + ], + "layer": "KONG", + "entity": "Service", + "name": "Kong-Service", + "isRoot": false, + "isDefault": true, + "expressions": [ + "avg(aggregate_labels(meter_kong_service_http_requests,sum))", + "avg(aggregate_labels(meter_kong_service_http_status{code='200'}, sum))", + "avg(aggregate_labels(meter_kong_service_http_status{code='404'}, sum))", + "avg(aggregate_labels(meter_kong_service_http_status{code='500'}, sum))" + ], + "expressionsConfig": [ + { + "label": "Avg HTTP Requests", + "unit": "req / s" + }, + { + "label": "Avg HTTP Status 200", + "unit": "req / s" + }, + { + "label": "Avg HTTP Status 404", + "unit": "req / s" + }, + { + "label": "Avg HTTP Status 500", + "unit": "req / s" + } + ] + } + } +] \ No newline at end of file diff --git a/skywalking-ui b/skywalking-ui index d65c18bd38..61449f4b17 160000 --- a/skywalking-ui +++ b/skywalking-ui @@ -1 +1 @@ -Subproject commit d65c18bd380a56df8886c931cbe72be2919667b6 +Subproject commit 61449f4b172a143d96cca139bed50839f5f2a5d6 diff --git a/test/e2e-v2/cases/kong/docker-compose.yml b/test/e2e-v2/cases/kong/docker-compose.yml new file mode 100644 index 0000000000..3bee88804f --- /dev/null +++ b/test/e2e-v2/cases/kong/docker-compose.yml @@ -0,0 +1,116 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +version: '2.1' + +services: + oap: + extends: + file: ../../script/docker-compose/base-compose.yml + service: oap + ports: + - "12800:12800" + networks: + - e2e + kong-db: + image: postgres:alpine + networks: + - e2e + expose: + - 5432 + environment: + POSTGRES_DB: kong + POSTGRES_USER: kong + POSTGRES_PASSWORD: kong + healthcheck: + test: [ "CMD", "bash", "-c", "cat < /dev/null > /dev/tcp/127.0.0.1/5432" ] + interval: 5s + timeout: 60s + retries: 120 + kong-migrations: + image: kong:3.8.0 + networks: + - e2e + environment: + - KONG_DATABASE=postgres + - KONG_PG_USER=kong + - KONG_PG_PASSWORD=kong + - KONG_PG_HOST=kong-db + - KONG_CASSANDRA_CONTACT_POINTS=kong-db + command: kong migrations bootstrap + depends_on: + kong-db: + condition: service_healthy + healthcheck: + test: [ "CMD", "kong", "health" ] + interval: 10s + timeout: 60s + retries: 120 + kong-1: + image: kong:3.8.0 + networks: + - e2e + depends_on: + kong-migrations: + condition: service_completed_successfully + environment: + KONG_ADMIN_ACCESS_LOG: /dev/stdout + KONG_ADMIN_ERROR_LOG: /dev/stderr + KONG_PROXY_LISTEN: "0.0.0.0:8000" + KONG_ADMIN_LISTEN: "0.0.0.0:8001" + KONG_CASSANDRA_CONTACT_POINTS: kong-db + KONG_DATABASE: postgres + KONG_PG_DATABASE: kong + KONG_PG_PASSWORD: kong + KONG_PG_HOST: kong-db + KONG_PG_USER: kong + KONG_PROXY_ACCESS_LOG: /dev/stdout + KONG_PROXY_ERROR_LOG: /dev/stderr + ports: + - "8001:8001" + - "8000:8000" + restart: on-failure + healthcheck: + test: [ "CMD", "kong", "health" ] + interval: 10s + timeout: 60s + retries: 120 + otel-collector: + image: otel/opentelemetry-collector:${OTEL_COLLECTOR_VERSION} + networks: + - e2e + command: [ "--config=/etc/otel-collector-config.yaml" ] + volumes: + - ./otel-collector-config.yaml:/etc/otel-collector-config.yaml + expose: + - 55678 + depends_on: + oap: + condition: service_healthy + kong-mock: + image: curlimages/curl:8.10.1 + networks: + - e2e + depends_on: + kong-1: + condition: service_healthy + oap: + condition: service_healthy + command: "sh /etc/kong-e2e-data-mock.sh" + volumes: + - ./kong-e2e-data-mock.sh:/etc/kong-e2e-data-mock.sh + +networks: + e2e: \ No newline at end of file diff --git a/test/e2e-v2/cases/kong/e2e.yaml b/test/e2e-v2/cases/kong/e2e.yaml new file mode 100644 index 0000000000..528eec9262 --- /dev/null +++ b/test/e2e-v2/cases/kong/e2e.yaml @@ -0,0 +1,37 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This file is used to show how to write configuration files and can be used to test. + +setup: + env: compose + file: docker-compose.yml + timeout: 20m + init-system-environment: ../../script/env + steps: + - name: set PATH + command: export PATH=/tmp/skywalking-infra-e2e/bin:$PATH + - name: install yq + command: bash test/e2e-v2/script/prepare/setup-e2e-shell/install.sh yq + - name: install swctl + command: bash test/e2e-v2/script/prepare/setup-e2e-shell/install.sh swctl + +verify: + retry: + count: 20 + interval: 3s + cases: + - includes: + - ./kong-cases.yaml diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth-endpoint.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth-endpoint.yml new file mode 100644 index 0000000000..7a0f02852f --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth-endpoint.yml @@ -0,0 +1,35 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: direction + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth-service.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth-service.yml new file mode 100644 index 0000000000..7a0f02852f --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth-service.yml @@ -0,0 +1,35 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: direction + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth.yml new file mode 100644 index 0000000000..ded3f115c1 --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-bandwidth.yml @@ -0,0 +1,37 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: direction + value: {{ .value }} + - key: route + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value-label-percentile.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-percentile.yml new file mode 100644 index 0000000000..0e662e432f --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-percentile.yml @@ -0,0 +1,35 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: p + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value-label-pid.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-pid.yml new file mode 100644 index 0000000000..a3082d647c --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-pid.yml @@ -0,0 +1,35 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: pid + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value-label-shared-dict.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-shared-dict.yml new file mode 100644 index 0000000000..1328a2e3ab --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-shared-dict.yml @@ -0,0 +1,35 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: shared_dict + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value-label-state.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-state.yml new file mode 100644 index 0000000000..ca75192102 --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-state.yml @@ -0,0 +1,35 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: state + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value-label-status.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-status.yml new file mode 100644 index 0000000000..2f8dfa8155 --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value-label-status.yml @@ -0,0 +1,35 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: code + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-has-value.yml b/test/e2e-v2/cases/kong/expected/metrics-has-value.yml new file mode 100644 index 0000000000..dc71f56632 --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-has-value.yml @@ -0,0 +1,31 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: TIME_SERIES_VALUES +results: + {{- contains .results }} + - metric: + labels: [] + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + - id: {{ notEmpty .id }} + value: null + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-single-value-label.yml b/test/e2e-v2/cases/kong/expected/metrics-single-value-label.yml new file mode 100644 index 0000000000..c4cb82f51e --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-single-value-label.yml @@ -0,0 +1,32 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: SINGLE_VALUE +results: + {{- contains .results }} + - metric: + labels: + {{- contains .metric.labels }} + - key: service_instance_id + value: {{ .value }} + {{- end}} + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/metrics-single-value.yml b/test/e2e-v2/cases/kong/expected/metrics-single-value.yml new file mode 100644 index 0000000000..1a70151859 --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/metrics-single-value.yml @@ -0,0 +1,28 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +type: SINGLE_VALUE +results: + {{- contains .results }} + - metric: + labels: [] + values: + {{- contains .values }} + - id: {{ notEmpty .id }} + value: {{ .value }} + traceid: null + {{- end}} + {{- end}} +error: null diff --git a/test/e2e-v2/cases/kong/expected/service.yml b/test/e2e-v2/cases/kong/expected/service.yml new file mode 100644 index 0000000000..8a4d7c6c52 --- /dev/null +++ b/test/e2e-v2/cases/kong/expected/service.yml @@ -0,0 +1,24 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +{{- contains . }} +- id: {{ b64enc "kong::kong-cluster" }}.1 + name: kong::kong-cluster + group: kong + shortname: kong-cluster + layers: + - KONG + normal: true +{{- end }} \ No newline at end of file diff --git a/test/e2e-v2/cases/kong/kong-cases.yaml b/test/e2e-v2/cases/kong/kong-cases.yaml new file mode 100644 index 0000000000..85d6786f48 --- /dev/null +++ b/test/e2e-v2/cases/kong/kong-cases.yaml @@ -0,0 +1,80 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This file is used to show how to write configuration files and can be used to test. + +cases: + # service list + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql service ls + expected: expected/service.yml + # service metrics + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='latest(aggregate_labels(meter_kong_service_nginx_metric_errors_total,sum))' --service-name=kong::kong-cluster + expected: expected/metrics-single-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='latest(aggregate_labels(meter_kong_service_datastore_reachable,sum(service_instance_id)))' --service-name=kong::kong-cluster + expected: expected/metrics-single-value-label.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='aggregate_labels(meter_kong_service_http_bandwidth,sum(direction))' --service-name=kong::kong-cluster + expected: expected/metrics-has-value-label-bandwidth-service.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='aggregate_labels(meter_kong_service_http_status,sum(code))' --service-name=kong::kong-cluster + expected: expected/metrics-has-value-label-status.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='aggregate_labels(meter_kong_service_http_requests,sum)' --service-name=kong::kong-cluster + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='aggregate_labels(meter_kong_service_nginx_connections_total,sum(state))' --service-name=kong::kong-cluster + expected: expected/metrics-has-value-label-state.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='aggregate_labels(meter_kong_service_nginx_timers,sum(state))' --service-name=kong::kong-cluster + expected: expected/metrics-has-value-label-state.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='aggregate_labels(meter_kong_service_kong_latency,avg(p))' --service-name=kong::kong-cluster + expected: expected/metrics-has-value-label-percentile.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='aggregate_labels(meter_kong_service_request_latency,avg(p))' --service-name=kong::kong-cluster + expected: expected/metrics-has-value-label-percentile.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression='aggregate_labels(meter_kong_service_upstream_latency,avg(p))' --service-name=kong::kong-cluster + expected: expected/metrics-has-value-label-percentile.yml + + # instance metrics + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_http_bandwidth --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-bandwidth.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_http_status --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-status.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_datastore_reachable --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_http_requests --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_shared_dict_bytes --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-shared-dict.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_shared_dict_total_bytes --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-shared-dict.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_memory_workers_lua_vms_bytes --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-pid.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_nginx_connections_total --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-state.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_nginx_timers --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-state.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_kong_latency --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-percentile.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_request_latency --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-percentile.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_instance_upstream_latency --service-name=kong::kong-cluster --instance-name=kong-1:8001 + expected: expected/metrics-has-value-label-percentile.yml + + # Endpoint metrics + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_endpoint_http_bandwidth --service-name=kong::kong-cluster --instance-name=kong-1:8001 --endpoint-name=sw_route + expected: expected/metrics-has-value-label-bandwidth-endpoint.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_endpoint_http_status --service-name=kong::kong-cluster --instance-name=kong-1:8001 --endpoint-name=sw_route + expected: expected/metrics-has-value-label-status.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_endpoint_kong_latency --service-name=kong::kong-cluster --instance-name=kong-1:8001 --endpoint-name=sw_route + expected: expected/metrics-has-value-label-percentile.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_endpoint_request_latency --service-name=kong::kong-cluster --instance-name=kong-1:8001 --endpoint-name=sw_route + expected: expected/metrics-has-value-label-percentile.yml + - query: swctl --display yaml --base-url=http://${oap_host}:${oap_12800}/graphql metrics exec --expression=meter_kong_endpoint_upstream_latency --service-name=kong::kong-cluster --instance-name=kong-1:8001 --endpoint-name=sw_route + expected: expected/metrics-has-value-label-percentile.yml \ No newline at end of file diff --git a/test/e2e-v2/cases/kong/kong-e2e-data-mock.sh b/test/e2e-v2/cases/kong/kong-e2e-data-mock.sh new file mode 100644 index 0000000000..dda1e69777 --- /dev/null +++ b/test/e2e-v2/cases/kong/kong-e2e-data-mock.sh @@ -0,0 +1,45 @@ +#!/bin/bash +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# This script is used to test the Kong plugin with the data mock service. + +# Add global plugins +curl -i -X POST http://kong-1:8001/plugins \ + --data name=prometheus \ + --data config.per_consumer=true \ + --data config.status_code_metrics=true \ + --data config.ai_metrics=true \ + --data config.latency_metrics=true \ + --data config.bandwidth_metrics=true \ + --data config.upstream_health_metrics=true +curl -i -X POST http://kong-1:8001/plugins \ + --data name=rate-limiting \ + --data config.minute=5 \ + --data config.policy=local + +# Add a mock service and route +curl -i -s -X POST http://kong-1:8001/services \ + --data name=sw_service \ + --data url='http://httpbin.konghq.com' +curl -i -X POST http://kong-1:8001/services/sw_service/routes \ + --data 'paths[]=/mock' \ + --data name=sw_route + +while true +do + curl -s -i http://kong-1:8000/mock/anything > /dev/null + sleep 5 +done \ No newline at end of file diff --git a/test/e2e-v2/cases/kong/otel-collector-config.yaml b/test/e2e-v2/cases/kong/otel-collector-config.yaml new file mode 100644 index 0000000000..feff62b04d --- /dev/null +++ b/test/e2e-v2/cases/kong/otel-collector-config.yaml @@ -0,0 +1,44 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +receivers: + prometheus: + config: + scrape_configs: + - job_name: 'kong-monitoring' + metrics_path: "/metrics" + scrape_interval: 10s + static_configs: + - targets: ['kong-1:8001'] + labels: + host_name: kong-cluster + +processors: + batch: + +exporters: + otlp: + endpoint: oap:11800 + tls: + insecure: true +service: + pipelines: + metrics: + receivers: + - prometheus + processors: + - batch + exporters: + - otlp \ No newline at end of file