├── .gitignore
├── README.md
├── apisix_conf
    └── config.yaml
├── apisix_log
    └── .keep
├── dashboard_conf
    └── conf.yaml
├── docker-compose.yml
├── etcd_conf
    └── etcd.conf.yml
├── example-curl-cmds
    ├── 10_create_versioning.sh
    ├── 11_create_versioned_route.sh
    ├── 12_test_new_versioned_route.sh
    ├── 13_redirect_to_versioned_route.sh
    ├── 14_update_first_route_plugin_config.sh
    ├── 15_test_http_301.sh
    ├── 16_enable_traffic_split.sh
    ├── 17_test_traffic_split.sh
    ├── 1_create_upstream.sh
    ├── 2_create_plugin_config.sh
    ├── 3_create_route.sh
    ├── 4_test_current_setup.sh
    ├── 5_add_consumer.sh
    ├── 6_enable_basic_auth_per_route.sh
    ├── 7_test_auth_after_enabled.sh
    ├── 8_apply_rate_policy.sh
    ├── 8_enable_prometheus_plugin.sh
    └── 9_test_rate_limit.sh
├── grafana_conf
    ├── config
    │   └── grafana.ini
    ├── dashboards
    │   └── apisix-grafana-dashboard.json
    └── provisioning
    │   ├── dashboards
    │       └── all.yaml
    │   └── datasources
    │       └── all.yaml
└── prometheus_conf
    └── prometheus.yml


/.gitignore:
--------------------------------------------------------------------------------
1 | /apisix_log/*
2 | !/apisix_log/.keep
3 | 
4 | /etcd_data/*
5 | !/etcd_data/.keep
6 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Manage OpenAI APIs with Apache APISIX Demo
2 | 
3 | In this example, Apache APISIX is used to create a simple API gateway that accesses the OpenAI API and manages the traffic by creating a route, upstream and enabling some plugins. 
4 | We are going to interact with OpenAI API Completion endpoint to create a product description generator to generate the product description efficiently and accurately.
5 | 
6 | Read the related blog post to follow all steps:
7 | 
8 | https://api7.ai/blog/power-ai-capabilities-with-apache-apisix
9 | 


--------------------------------------------------------------------------------
/apisix_conf/config.yaml:
--------------------------------------------------------------------------------
 1 | #
 2 | # Licensed to the Apache Software Foundation (ASF) under one or more
 3 | # contributor license agreements.  See the NOTICE file distributed with
 4 | # this work for additional information regarding copyright ownership.
 5 | # The ASF licenses this file to You under the Apache License, Version 2.0
 6 | # (the "License"); you may not use this file except in compliance with
 7 | # the License.  You may obtain a copy of the License at
 8 | #
 9 | #     http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 | 
18 | apisix:
19 |   node_listen: 9080              # APISIX listening port
20 |   enable_ipv6: false
21 | 
22 |   enable_control: true
23 |   control:
24 |     ip: "0.0.0.0"
25 |     port: 9092
26 | 
27 | deployment:
28 |   admin:
29 |     allow_admin:               # http://nginx.org/en/docs/http/ngx_http_access_module.html#allow
30 |       - 0.0.0.0/0              # We need to restrict ip access rules for security. 0.0.0.0/0 is for test.
31 | 
32 |     admin_key:
33 |       - name: "admin"
34 |         key: edd1c9f034335f136f87ad84b625c8f1
35 |         role: admin                 # admin: manage all configuration data
36 | 
37 |       - name: "viewer"
38 |         key: 4054f7cf07e344346cd3f287985e76a2
39 |         role: viewer
40 | 
41 |   etcd:
42 |     host:                           # it's possible to define multiple etcd hosts addresses of the same etcd cluster.
43 |       - "http://etcd:2379"          # multiple etcd address
44 |     prefix: "/apisix"               # apisix configurations prefix
45 |     timeout: 30                     # 30 seconds
46 | 
47 | plugin_attr:
48 |   prometheus:
49 |     export_addr:
50 |       ip: "0.0.0.0"
51 |       port: 9091
52 | 


--------------------------------------------------------------------------------
/apisix_log/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Boburmirzo/apisix-open-ai-api/0e66a20bce9c532bebe05a5e9efe6c48f6625a98/apisix_log/.keep


--------------------------------------------------------------------------------
/dashboard_conf/conf.yaml:
--------------------------------------------------------------------------------
  1 | #
  2 | # Licensed to the Apache Software Foundation (ASF) under one or more
  3 | # contributor license agreements.  See the NOTICE file distributed with
  4 | # this work for additional information regarding copyright ownership.
  5 | # The ASF licenses this file to You under the Apache License, Version 2.0
  6 | # (the "License"); you may not use this file except in compliance with
  7 | # the License.  You may obtain a copy of the License at
  8 | #
  9 | #     http://www.apache.org/licenses/LICENSE-2.0
 10 | #
 11 | # Unless required by applicable law or agreed to in writing, software
 12 | # distributed under the License is distributed on an "AS IS" BASIS,
 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14 | # See the License for the specific language governing permissions and
 15 | # limitations under the License.
 16 | #
 17 | 
 18 | conf:
 19 |   listen:
 20 |     host: 0.0.0.0     # `manager api` listening ip or host name
 21 |     port: 9000          # `manager api` listening port
 22 |   allow_list:           # If we don't set any IP list, then any IP access is allowed by default.
 23 |     - 0.0.0.0/0
 24 |   etcd:
 25 |     endpoints:          # supports defining multiple etcd host addresses for an etcd cluster
 26 |       - "http://etcd:2379"
 27 |                           # yamllint disable rule:comments-indentation
 28 |                           # etcd basic auth info
 29 |     # username: "root"    # ignore etcd username if not enable etcd auth
 30 |     # password: "123456"  # ignore etcd password if not enable etcd auth
 31 |     mtls:
 32 |       key_file: ""          # Path of your self-signed client side key
 33 |       cert_file: ""         # Path of your self-signed client side cert
 34 |       ca_file: ""           # Path of your self-signed ca cert, the CA is used to sign callers' certificates
 35 |     # prefix: /apisix     # apisix config's prefix in etcd, /apisix by default
 36 |   log:
 37 |     error_log:
 38 |       level: warn       # supports levels, lower to higher: debug, info, warn, error, panic, fatal
 39 |       file_path:
 40 |         logs/error.log  # supports relative path, absolute path, standard output
 41 |                         # such as: logs/error.log, /tmp/logs/error.log, /dev/stdout, /dev/stderr
 42 |     access_log:
 43 |       file_path:
 44 |         logs/access.log  # supports relative path, absolute path, standard output
 45 |                          # such as: logs/access.log, /tmp/logs/access.log, /dev/stdout, /dev/stderr
 46 |                          # log example: 2020-12-09T16:38:09.039+0800	INFO	filter/logging.go:46	/apisix/admin/routes/r1	{"status": 401, "host": "127.0.0.1:9000", "query": "asdfsafd=adf&a=a", "requestId": "3d50ecb8-758c-46d1-af5b-cd9d1c820156", "latency": 0, "remoteIP": "127.0.0.1", "method": "PUT", "errs": []}
 47 |   security:
 48 |       # access_control_allow_origin: "http://httpbin.org"
 49 |       # access_control_allow_credentials: true          # support using custom cors configration
 50 |       # access_control_allow_headers: "Authorization"
 51 |       # access_control-allow_methods: "*"
 52 |       # x_frame_options: "deny"
 53 |       content_security_policy: "default-src 'self'; script-src 'self' 'unsafe-eval' 'unsafe-inline'; style-src 'self' 'unsafe-inline'; frame-src *"  # You can set frame-src to provide content for your grafana panel.
 54 | 
 55 | authentication:
 56 |   secret:
 57 |     secret              # secret for jwt token generation.
 58 |                         # NOTE: Highly recommended to modify this value to protect `manager api`.
 59 |                         # if it's default value, when `manager api` start, it will generate a random string to replace it.
 60 |   expire_time: 3600     # jwt token expire time, in second
 61 |   users:                # yamllint enable rule:comments-indentation
 62 |     - username: admin   # username and password for login `manager api`
 63 |       password: admin
 64 |     - username: user
 65 |       password: user
 66 | 
 67 | plugins:                          # plugin list (sorted in alphabetical order)
 68 |   - api-breaker
 69 |   - authz-keycloak
 70 |   - basic-auth
 71 |   - batch-requests
 72 |   - consumer-restriction
 73 |   - cors
 74 |   # - dubbo-proxy
 75 |   - echo
 76 |   # - error-log-logger
 77 |   # - example-plugin
 78 |   - fault-injection
 79 |   - grpc-transcode
 80 |   - hmac-auth
 81 |   - http-logger
 82 |   - ip-restriction
 83 |   - jwt-auth
 84 |   - kafka-logger
 85 |   - key-auth
 86 |   - limit-conn
 87 |   - limit-count
 88 |   - limit-req
 89 |   # - log-rotate
 90 |   # - node-status
 91 |   - openid-connect
 92 |   - prometheus
 93 |   - proxy-cache
 94 |   - proxy-mirror
 95 |   - proxy-rewrite
 96 |   - redirect
 97 |   - referer-restriction
 98 |   - request-id
 99 |   - request-validation
100 |   - response-rewrite
101 |   - serverless-post-function
102 |   - serverless-pre-function
103 |   # - skywalking
104 |   - sls-logger
105 |   - syslog
106 |   - tcp-logger
107 |   - udp-logger
108 |   - uri-blocker
109 |   - wolf-rbac
110 |   - zipkin
111 |   - server-info
112 |   - traffic-split
113 | 


--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
 1 | #
 2 | # Licensed to the Apache Software Foundation (ASF) under one or more
 3 | # contributor license agreements.  See the NOTICE file distributed with
 4 | # this work for additional information regarding copyright ownership.
 5 | # The ASF licenses this file to You under the Apache License, Version 2.0
 6 | # (the "License"); you may not use this file except in compliance with
 7 | # the License.  You may obtain a copy of the License at
 8 | #
 9 | #     http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 | 
18 | version: "3"
19 | 
20 | services:
21 |   apisix-dashboard:
22 |     image: apache/apisix-dashboard:2.15.0-alpine
23 |     restart: always
24 |     volumes:
25 |     - ./dashboard_conf/conf.yaml:/usr/local/apisix-dashboard/conf/conf.yaml
26 |     ports:
27 |     - "9000:9000"
28 |     networks:
29 |       apisix:
30 | 
31 |   apisix:
32 |     image: apache/apisix:latest
33 |     restart: always
34 |     volumes:
35 |       - ./apisix_log:/usr/local/apisix/logs
36 |       - ./apisix_conf/config.yaml:/usr/local/apisix/conf/config.yaml:ro
37 |     depends_on:
38 |       - etcd
39 |     ##network_mode: host
40 |     ports:
41 |       - "9180:9180/tcp"
42 |       - "9080:9080/tcp"
43 |       - "9091:9091/tcp"
44 |       - "9443:9443/tcp"
45 |       - "9092:9092/tcp"
46 |     networks:
47 |       apisix:
48 | 
49 |   etcd:
50 |     image: bitnami/etcd:3.4.15
51 |     restart: always
52 |     volumes:
53 |       - etcd_data:/bitnami/etcd
54 |     environment:
55 |       ETCD_ENABLE_V2: "true"
56 |       ALLOW_NONE_AUTHENTICATION: "yes"
57 |       ETCD_ADVERTISE_CLIENT_URLS: "http://etcd:2379"
58 |       ETCD_LISTEN_CLIENT_URLS: "http://0.0.0.0:2379"
59 |     ports:
60 |       - "12379:2379/tcp"
61 |     networks:
62 |       apisix:
63 | 
64 |   prometheus:
65 |     image: prom/prometheus:v2.25.0
66 |     restart: always
67 |     volumes:
68 |       - ./prometheus_conf/prometheus.yml:/etc/prometheus/prometheus.yml
69 |     ports:
70 |       - "9090:9090"
71 |     networks:
72 |       apisix:
73 | 
74 |   grafana:
75 |     image: grafana/grafana:7.3.7
76 |     restart: always
77 |     ports:
78 |       - "3000:3000"
79 |     volumes:
80 |       - "./grafana_conf/provisioning:/etc/grafana/provisioning"
81 |       - "./grafana_conf/dashboards:/var/lib/grafana/dashboards"
82 |       - "./grafana_conf/config/grafana.ini:/etc/grafana/grafana.ini"
83 |     networks:
84 |       apisix:
85 | 
86 | networks:
87 |   apisix:
88 |     driver: bridge
89 | 
90 | volumes:
91 |   etcd_data:
92 |     driver: local
93 | 


--------------------------------------------------------------------------------
/etcd_conf/etcd.conf.yml:
--------------------------------------------------------------------------------
  1 | #
  2 | # Licensed to the Apache Software Foundation (ASF) under one or more
  3 | # contributor license agreements.  See the NOTICE file distributed with
  4 | # this work for additional information regarding copyright ownership.
  5 | # The ASF licenses this file to You under the Apache License, Version 2.0
  6 | # (the "License"); you may not use this file except in compliance with
  7 | # the License.  You may obtain a copy of the License at
  8 | #
  9 | #     http://www.apache.org/licenses/LICENSE-2.0
 10 | #
 11 | # Unless required by applicable law or agreed to in writing, software
 12 | # distributed under the License is distributed on an "AS IS" BASIS,
 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14 | # See the License for the specific language governing permissions and
 15 | # limitations under the License.
 16 | #
 17 | 
 18 | # This is the configuration file for the etcd server.
 19 | 
 20 | # Human-readable name for this member.
 21 | name: 'default'
 22 | 
 23 | # Path to the data directory.
 24 | data-dir:
 25 | 
 26 | # Path to the dedicated wal directory.
 27 | wal-dir:
 28 | 
 29 | # Number of committed transactions to trigger a snapshot to disk.
 30 | snapshot-count: 10000
 31 | 
 32 | # Time (in milliseconds) of a heartbeat interval.
 33 | heartbeat-interval: 100
 34 | 
 35 | # Time (in milliseconds) for an election to timeout.
 36 | election-timeout: 1000
 37 | 
 38 | # Raise alarms when backend size exceeds the given quota. 0 means use the
 39 | # default quota.
 40 | quota-backend-bytes: 0
 41 | 
 42 | # List of comma separated URLs to listen on for peer traffic.
 43 | listen-peer-urls: http://localhost:2380
 44 | 
 45 | # List of comma separated URLs to listen on for client traffic.
 46 | listen-client-urls: http://localhost:2379
 47 | 
 48 | # Maximum number of snapshot files to retain (0 is unlimited).
 49 | max-snapshots: 5
 50 | 
 51 | # Maximum number of wal files to retain (0 is unlimited).
 52 | max-wals: 5
 53 | 
 54 | # Comma-separated white list of origins for CORS (cross-origin resource sharing).
 55 | cors:
 56 | 
 57 | # List of this member's peer URLs to advertise to the rest of the cluster.
 58 | # The URLs needed to be a comma-separated list.
 59 | initial-advertise-peer-urls: http://localhost:2380
 60 | 
 61 | # List of this member's client URLs to advertise to the public.
 62 | # The URLs needed to be a comma-separated list.
 63 | advertise-client-urls: http://localhost:2379
 64 | 
 65 | # Discovery URL used to bootstrap the cluster.
 66 | discovery:
 67 | 
 68 | # Valid values include 'exit', 'proxy'
 69 | discovery-fallback: 'proxy'
 70 | 
 71 | # HTTP proxy to use for traffic to discovery service.
 72 | discovery-proxy:
 73 | 
 74 | # DNS domain used to bootstrap initial cluster.
 75 | discovery-srv:
 76 | 
 77 | # Initial cluster configuration for bootstrapping.
 78 | initial-cluster:
 79 | 
 80 | # Initial cluster token for the etcd cluster during bootstrap.
 81 | initial-cluster-token: 'etcd-cluster'
 82 | 
 83 | # Initial cluster state ('new' or 'existing').
 84 | initial-cluster-state: 'new'
 85 | 
 86 | # Reject reconfiguration requests that would cause quorum loss.
 87 | strict-reconfig-check: false
 88 | 
 89 | # Accept etcd V2 client requests
 90 | enable-v2: true
 91 | 
 92 | # Enable runtime profiling data via HTTP server
 93 | enable-pprof: true
 94 | 
 95 | # Valid values include 'on', 'readonly', 'off'
 96 | proxy: 'off'
 97 | 
 98 | # Time (in milliseconds) an endpoint will be held in a failed state.
 99 | proxy-failure-wait: 5000
100 | 
101 | # Time (in milliseconds) of the endpoints refresh interval.
102 | proxy-refresh-interval: 30000
103 | 
104 | # Time (in milliseconds) for a dial to timeout.
105 | proxy-dial-timeout: 1000
106 | 
107 | # Time (in milliseconds) for a write to timeout.
108 | proxy-write-timeout: 5000
109 | 
110 | # Time (in milliseconds) for a read to timeout.
111 | proxy-read-timeout: 0
112 | 
113 | client-transport-security:
114 |   # Path to the client server TLS cert file.
115 |   cert-file:
116 | 
117 |   # Path to the client server TLS key file.
118 |   key-file:
119 | 
120 |   # Enable client cert authentication.
121 |   client-cert-auth: false
122 | 
123 |   # Path to the client server TLS trusted CA cert file.
124 |   trusted-ca-file:
125 | 
126 |   # Client TLS using generated certificates
127 |   auto-tls: false
128 | 
129 | peer-transport-security:
130 |   # Path to the peer server TLS cert file.
131 |   cert-file:
132 | 
133 |   # Path to the peer server TLS key file.
134 |   key-file:
135 | 
136 |   # Enable peer client cert authentication.
137 |   client-cert-auth: false
138 | 
139 |   # Path to the peer server TLS trusted CA cert file.
140 |   trusted-ca-file:
141 | 
142 |   # Peer TLS using generated certificates.
143 |   auto-tls: false
144 | 
145 | # Enable debug-level logging for etcd.
146 | debug: false
147 | 
148 | logger: zap
149 | 
150 | # Specify 'stdout' or 'stderr' to skip journald logging even when running under systemd.
151 | log-outputs: [stderr]
152 | 
153 | # Force to create a new one member cluster.
154 | force-new-cluster: false
155 | 
156 | auto-compaction-mode: periodic
157 | auto-compaction-retention: "1"
158 | 


--------------------------------------------------------------------------------
/example-curl-cmds/10_create_versioning.sh:
--------------------------------------------------------------------------------
1 | curl http://127.0.0.1:9180/apisix/admin/plugin_configs/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -d ' 
2 | {
3 |   "plugins": {
4 |     "proxy-rewrite": {
5 |       "regex_uri": ["/v1/(.*)", "/$1"]
6 |     }
7 |   }
8 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/11_create_versioned_route.sh:
--------------------------------------------------------------------------------
 1 | curl -i http://127.0.0.1:9180/apisix/admin/routes/2 \
 2 | -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 3 | {
 4 |    "name":"OpenAI API completion route",
 5 |    "desc":"Create a new route in APISIX for the OpenAI API completion endpoint",
 6 |    "methods":[
 7 |       "POST"
 8 |    ],
 9 |    "uris": ["/v1/openai/product/desc", "/v1/openai/product/desc/", "/v1/openai/product/desc/*"],
10 |    "upstream_id":"1",
11 |    "plugin_config_id":1
12 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/12_test_new_versioned_route.sh:
--------------------------------------------------------------------------------
1 | curl -i -u username1:password1 http://127.0.0.1:9080/v1/openai/product/desc  -X POST -d \
2 | '{
3 |    "model":"text-davinci-003",
4 |    "prompt":"Write a brief product description for Apple 13 pro",
5 |    "temperature":0,
6 |    "max_tokens":256
7 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/13_redirect_to_versioned_route.sh:
--------------------------------------------------------------------------------
1 | curl -L http://127.0.0.1:9180/apisix/admin/plugin_configs/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' 
2 | {
3 |   "plugins": {
4 |     "redirect": {
5 |       "uri": "/v1$uri",
6 |       "ret_code": 301
7 |     }
8 |   }
9 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/14_update_first_route_plugin_config.sh:
--------------------------------------------------------------------------------
1 | curl -i http://127.0.0.1:9180/apisix/admin/routes/1 \
2 | -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -d '
3 | {
4 |    "plugin_config_id":2
5 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/15_test_http_301.sh:
--------------------------------------------------------------------------------
1 | curl -i -u username1:password1 http://127.0.0.1:9080/openai/product/desc  -X POST -d \
2 | '{
3 |    "model":"text-davinci-003",
4 |    "prompt":"Write a brief product description for Apple 13 pro",
5 |    "temperature":0,
6 |    "max_tokens":256
7 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/16_enable_traffic_split.sh:
--------------------------------------------------------------------------------
 1 | curl http://127.0.0.1:9180/apisix/admin/plugin_configs/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -d ' 
 2 | {
 3 |   "plugins": {
 4 |     "traffic-split": {
 5 |       "rules": [
 6 |         {
 7 |           "weighted_upstreams": [      
 8 |             {
 9 |               "upstream_id": 2,
10 |               "weight": 1
11 |             },
12 |             {
13 |               "weight": 1
14 |             }
15 |           ]
16 |         }
17 |       ]
18 |     }
19 |   }
20 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/17_test_traffic_split.sh:
--------------------------------------------------------------------------------
1 | curl -i -u username1:password1 http://127.0.0.1:9080/v1/openai/product/desc  -X POST -d \
2 | '{
3 |    "model":"text-davinci-003",
4 |    "prompt":"Write a brief product description for Apple 13 pro",
5 |    "temperature":0,
6 |    "max_tokens":256
7 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/1_create_upstream.sh:
--------------------------------------------------------------------------------
 1 | curl "http://127.0.0.1:9180/apisix/admin/upstreams/1" -H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" -X PUT -d '
 2 | {
 3 |   "name": "OpenAI API upstream",
 4 |   "desc": "Add the OpenAI API domain as the upstream",
 5 |   "type": "roundrobin",
 6 |   "scheme": "https",
 7 |   "nodes": {
 8 |     "api.openai.com:443": 1
 9 |   }
10 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/2_create_plugin_config.sh:
--------------------------------------------------------------------------------
 1 | curl http://127.0.0.1:9180/apisix/admin/plugin_configs/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d ' 
 2 | {
 3 |    "plugins":{
 4 |       "proxy-rewrite":{
 5 |          "uri":"/v1/completions",
 6 |          "host":"api.openai.com",
 7 |          "headers":{
 8 |             "Authorization":"OpenAI API Key",
 9 |             "Content-Type":"application/json"
10 |          }
11 |       }
12 |    }
13 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/3_create_route.sh:
--------------------------------------------------------------------------------
 1 | curl -i http://127.0.0.1:9180/apisix/admin/routes/1 \
 2 | -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 3 | {
 4 |    "name":"OpenAI API completion route",
 5 |    "desc":"Create a new route in APISIX for the OpenAI API completion endpoint",
 6 |    "methods":[
 7 |       "POST"
 8 |    ],
 9 |    "uri":"/openai/product/desc",
10 |    "upstream_id":"1",
11 |    "plugin_config_id":1
12 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/4_test_current_setup.sh:
--------------------------------------------------------------------------------
1 | curl http://127.0.0.1:9080/openai/product/desc -X POST -d \
2 | '{
3 |    "model":"text-davinci-003",
4 |    "prompt":"Write a brief product description for Apple 13 pro",
5 |    "temperature":0,
6 |    "max_tokens":256
7 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/5_add_consumer.sh:
--------------------------------------------------------------------------------
 1 | curl http://127.0.0.1:9180/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
 2 | {
 3 |     "username": "consumer1",
 4 |     "plugins": {
 5 |         "basic-auth": {
 6 |             "username": "username1",
 7 |             "password": "password1"
 8 |         }
 9 |     }
10 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/6_enable_basic_auth_per_route.sh:
--------------------------------------------------------------------------------
1 | curl http://127.0.0.1:9180/apisix/admin/plugin_configs/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -d ' 
2 | {
3 |    "plugins":{
4 |       "basic-auth":{
5 |       }
6 |    }
7 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/7_test_auth_after_enabled.sh:
--------------------------------------------------------------------------------
1 | curl -i -u username1:password1 http://127.0.0.1:9080/openai/product/desc  -X POST -d \
2 | '{
3 |    "model":"text-davinci-003",
4 |    "prompt":"Write a brief product description for Apple 13 pro",
5 |    "temperature":0,
6 |    "max_tokens":256
7 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/8_apply_rate_policy.sh:
--------------------------------------------------------------------------------
 1 | curl http://127.0.0.1:9180/apisix/admin/plugin_configs/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -d ' 
 2 | {
 3 |    "plugins":{
 4 |       "limit-count":{
 5 |          "count":2,
 6 |          "time_window":60,
 7 |          "rejected_code":403,
 8 |          "rejected_msg":"Requests are too frequent, please try again later.",
 9 |          "key_type":"var",
10 |          "key":"remote_addr"
11 |       }
12 |    }
13 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/8_enable_prometheus_plugin.sh:
--------------------------------------------------------------------------------
1 | curl http://127.0.0.1:9180/apisix/admin/plugin_configs/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PATCH -d ' 
2 | {
3 |    "plugins":{
4 |       "prometheus":{}
5 |    }
6 | }'


--------------------------------------------------------------------------------
/example-curl-cmds/9_test_rate_limit.sh:
--------------------------------------------------------------------------------
1 | curl -i -u username1:password1 http://127.0.0.1:9080/openai/product/desc  -X POST -d \
2 | '{
3 |    "model":"text-davinci-003",
4 |    "prompt":"Write a brief product description for Apple 13 pro",
5 |    "temperature":0,
6 |    "max_tokens":256
7 | }'


--------------------------------------------------------------------------------
/grafana_conf/config/grafana.ini:
--------------------------------------------------------------------------------
  1 | ##################### Grafana Configuration Example #####################
  2 | #
  3 | # Everything has defaults so you only need to uncomment things you want to
  4 | # change
  5 | 
  6 | # possible values : production, development
  7 | ;app_mode = production
  8 | 
  9 | # instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty
 10 | ;instance_name = ${HOSTNAME}
 11 | 
 12 | #################################### Paths ####################################
 13 | [paths]
 14 | # Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used)
 15 | ;data = /var/lib/grafana
 16 | 
 17 | # Temporary files in `data` directory older than given duration will be removed
 18 | ;temp_data_lifetime = 24h
 19 | 
 20 | # Directory where grafana can store logs
 21 | ;logs = /var/log/grafana
 22 | 
 23 | # Directory where grafana will automatically scan and look for plugins
 24 | ;plugins = /var/lib/grafana/plugins
 25 | 
 26 | # folder that contains provisioning config files that grafana will apply on startup and while running.
 27 | ;provisioning = conf/provisioning
 28 | 
 29 | #################################### Server ####################################
 30 | [server]
 31 | # Protocol (http, https, h2, socket)
 32 | ;protocol = http
 33 | 
 34 | # The ip address to bind to, empty will bind to all interfaces
 35 | ;http_addr =
 36 | 
 37 | # The http port  to use
 38 | ;http_port = 3000
 39 | 
 40 | # The public facing domain name used to access grafana from a browser
 41 | ;domain = localhost
 42 | 
 43 | # Redirect to correct domain if host header does not match domain
 44 | # Prevents DNS rebinding attacks
 45 | ;enforce_domain = false
 46 | 
 47 | # The full public facing url you use in browser, used for redirects and emails
 48 | # If you use reverse proxy and sub path specify full url (with sub path)
 49 | ;root_url = %(protocol)s://%(domain)s:%(http_port)s/
 50 | 
 51 | # Serve Grafana from subpath specified in `root_url` setting. By default it is set to `false` for compatibility reasons.
 52 | ;serve_from_sub_path = false
 53 | 
 54 | # Log web requests
 55 | ;router_logging = false
 56 | 
 57 | # the path relative working path
 58 | ;static_root_path = public
 59 | 
 60 | # enable gzip
 61 | ;enable_gzip = false
 62 | 
 63 | # https certs & key file
 64 | ;cert_file =
 65 | ;cert_key =
 66 | 
 67 | # Unix socket path
 68 | ;socket =
 69 | 
 70 | #################################### Database ####################################
 71 | [database]
 72 | # You can configure the database connection by specifying type, host, name, user and password
 73 | # as separate properties or as on string using the url properties.
 74 | 
 75 | # Either "mysql", "postgres" or "sqlite3", it's your choice
 76 | ;type = sqlite3
 77 | ;host = 127.0.0.1:3306
 78 | ;name = grafana
 79 | ;user = root
 80 | # If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
 81 | ;password =
 82 | 
 83 | # Use either URL or the previous fields to configure the database
 84 | # Example: mysql://user:secret@host:port/database
 85 | ;url =
 86 | 
 87 | # For "postgres" only, either "disable", "require" or "verify-full"
 88 | ;ssl_mode = disable
 89 | 
 90 | ;ca_cert_path =
 91 | ;client_key_path =
 92 | ;client_cert_path =
 93 | ;server_cert_name =
 94 | 
 95 | # For "sqlite3" only, path relative to data_path setting
 96 | ;path = grafana.db
 97 | 
 98 | # Max idle conn setting default is 2
 99 | ;max_idle_conn = 2
100 | 
101 | # Max conn setting default is 0 (mean not set)
102 | ;max_open_conn =
103 | 
104 | # Connection Max Lifetime default is 14400 (means 14400 seconds or 4 hours)
105 | ;conn_max_lifetime = 14400
106 | 
107 | # Set to true to log the sql calls and execution times.
108 | ;log_queries =
109 | 
110 | # For "sqlite3" only. cache mode setting used for connecting to the database. (private, shared)
111 | ;cache_mode = private
112 | 
113 | #################################### Cache server #############################
114 | [remote_cache]
115 | # Either "redis", "memcached" or "database" default is "database"
116 | ;type = database
117 | 
118 | # cache connectionstring options
119 | # database: will use Grafana primary database.
120 | # redis: config like redis server e.g. `addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false`. Only addr is required. ssl may be 'true', 'false', or 'insecure'.
121 | # memcache: 127.0.0.1:11211
122 | ;connstr =
123 | 
124 | #################################### Data proxy ###########################
125 | [dataproxy]
126 | 
127 | # This enables data proxy logging, default is false
128 | ;logging = false
129 | 
130 | # How long the data proxy should wait before timing out default is 30 (seconds)
131 | ;timeout = 30
132 | 
133 | # If enabled and user is not anonymous, data proxy will add X-Grafana-User header with username into the request, default is false.
134 | ;send_user_header = false
135 | 
136 | #################################### Analytics ####################################
137 | [analytics]
138 | # Server reporting, sends usage counters to stats.grafana.org every 24 hours.
139 | # No ip addresses are being tracked, only simple counters to track
140 | # running instances, dashboard and error counts. It is very helpful to us.
141 | # Change this option to false to disable reporting.
142 | ;reporting_enabled = true
143 | 
144 | # Set to false to disable all checks to https://grafana.net
145 | # for new vesions (grafana itself and plugins), check is used
146 | # in some UI views to notify that grafana or plugin update exists
147 | # This option does not cause any auto updates, nor send any information
148 | # only a GET request to http://grafana.com to get latest versions
149 | ;check_for_updates = true
150 | 
151 | # Google Analytics universal tracking code, only enabled if you specify an id here
152 | ;google_analytics_ua_id =
153 | 
154 | # Google Tag Manager ID, only enabled if you specify an id here
155 | ;google_tag_manager_id =
156 | 
157 | #################################### Security ####################################
158 | [security]
159 | # disable creation of admin user on first start of grafana
160 | ;disable_initial_admin_creation = false
161 | 
162 | # default admin user, created on startup
163 | ;admin_user = admin
164 | 
165 | # default admin password, can be changed before first start of grafana,  or in profile settings
166 | ;admin_password = admin
167 | 
168 | # used for signing
169 | ;secret_key = SW2YcwTIb9zpOOhoPsMm
170 | 
171 | # disable gravatar profile images
172 | ;disable_gravatar = false
173 | 
174 | # data source proxy whitelist (ip_or_domain:port separated by spaces)
175 | ;data_source_proxy_whitelist =
176 | 
177 | # disable protection against brute force login attempts
178 | ;disable_brute_force_login_protection = false
179 | 
180 | # set to true if you host Grafana behind HTTPS. default is false.
181 | ;cookie_secure = false
182 | 
183 | # set cookie SameSite attribute. defaults to `lax`. can be set to "lax", "strict", "none" and "disabled"
184 | ;cookie_samesite = none
185 | 
186 | # set to true if you want to allow browsers to render Grafana in a <frame>, <iframe>, <embed> or <object>. default is false.
187 | allow_embedding = true
188 | 
189 | # Set to true if you want to enable http strict transport security (HSTS) response header.
190 | # This is only sent when HTTPS is enabled in this configuration.
191 | # HSTS tells browsers that the site should only be accessed using HTTPS.
192 | # The default version will change to true in the next minor release, 6.3.
193 | ;strict_transport_security = false
194 | 
195 | # Sets how long a browser should cache HSTS. Only applied if strict_transport_security is enabled.
196 | ;strict_transport_security_max_age_seconds = 86400
197 | 
198 | # Set to true if to enable HSTS preloading option. Only applied if strict_transport_security is enabled.
199 | ;strict_transport_security_preload = false
200 | 
201 | # Set to true if to enable the HSTS includeSubDomains option. Only applied if strict_transport_security is enabled.
202 | ;strict_transport_security_subdomains = false
203 | 
204 | # Set to true to enable the X-Content-Type-Options response header.
205 | # The X-Content-Type-Options response HTTP header is a marker used by the server to indicate that the MIME types advertised
206 | # in the Content-Type headers should not be changed and be followed. The default will change to true in the next minor release, 6.3.
207 | ;x_content_type_options = false
208 | 
209 | # Set to true to enable the X-XSS-Protection header, which tells browsers to stop pages from loading
210 | # when they detect reflected cross-site scripting (XSS) attacks. The default will change to true in the next minor release, 6.3.
211 | ;x_xss_protection = false
212 | 
213 | #################################### Snapshots ###########################
214 | [snapshots]
215 | # snapshot sharing options
216 | ;external_enabled = true
217 | ;external_snapshot_url = https://snapshots-origin.raintank.io
218 | ;external_snapshot_name = Publish to snapshot.raintank.io
219 | 
220 | # Set to true to enable this Grafana instance act as an external snapshot server and allow unauthenticated requests for
221 | # creating and deleting snapshots.
222 | ;public_mode = false
223 | 
224 | # remove expired snapshot
225 | ;snapshot_remove_expired = true
226 | 
227 | #################################### Dashboards History ##################
228 | [dashboards]
229 | # Number dashboard versions to keep (per dashboard). Default: 20, Minimum: 1
230 | ;versions_to_keep = 20
231 | 
232 | # Minimum dashboard refresh interval. When set, this will restrict users to set the refresh interval of a dashboard lower than given interval. Per default this is 5 seconds.
233 | # The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
234 | ;min_refresh_interval = 5s
235 | 
236 | #################################### Users ###############################
237 | [users]
238 | # disable user signup / registration
239 | ;allow_sign_up = true
240 | 
241 | # Allow non admin users to create organizations
242 | ;allow_org_create = true
243 | 
244 | # Set to true to automatically assign new users to the default organization (id 1)
245 | ;auto_assign_org = true
246 | 
247 | # Set this value to automatically add new users to the provided organization (if auto_assign_org above is set to true)
248 | ;auto_assign_org_id = 1
249 | 
250 | # Default role new users will be automatically assigned (if disabled above is set to true)
251 | ;auto_assign_org_role = Viewer
252 | 
253 | # Require email validation before sign up completes
254 | ;verify_email_enabled = false
255 | 
256 | # Background text for the user field on the login page
257 | ;login_hint = email or username
258 | ;password_hint = password
259 | 
260 | # Default UI theme ("dark" or "light")
261 | ;default_theme = dark
262 | 
263 | # External user management, these options affect the organization users view
264 | ;external_manage_link_url =
265 | ;external_manage_link_name =
266 | ;external_manage_info =
267 | 
268 | # Viewers can edit/inspect dashboard settings in the browser. But not save the dashboard.
269 | ;viewers_can_edit = false
270 | 
271 | # Editors can administrate dashboard, folders and teams they create
272 | ;editors_can_admin = false
273 | 
274 | [auth]
275 | # Login cookie name
276 | ;login_cookie_name = grafana_session
277 | 
278 | # The lifetime (days) an authenticated user can be inactive before being required to login at next visit. Default is 7 days,
279 | ;login_maximum_inactive_lifetime_days = 7
280 | 
281 | # The maximum lifetime (days) an authenticated user can be logged in since login time before being required to login. Default is 30 days.
282 | ;login_maximum_lifetime_days = 30
283 | 
284 | # How often should auth tokens be rotated for authenticated users when being active. The default is each 10 minutes.
285 | ;token_rotation_interval_minutes = 10
286 | 
287 | # Set to true to disable (hide) the login form, useful if you use OAuth, defaults to false
288 | ;disable_login_form = false
289 | 
290 | # Set to true to disable the signout link in the side menu. useful if you use auth.proxy, defaults to false
291 | ;disable_signout_menu = false
292 | 
293 | # URL to redirect the user to after sign out
294 | ;signout_redirect_url =
295 | 
296 | # Set to true to attempt login with OAuth automatically, skipping the login screen.
297 | # This setting is ignored if multiple OAuth providers are configured.
298 | ;oauth_auto_login = false
299 | 
300 | # OAuth state max age cookie duration. Defaults to 60 seconds.
301 | ;oauth_state_cookie_max_age = 60
302 | 
303 | # limit of api_key seconds to live before expiration
304 | ;api_key_max_seconds_to_live = -1
305 | 
306 | #################################### Anonymous Auth ######################
307 | [auth.anonymous]
308 | # enable anonymous access
309 | enabled = true
310 | 
311 | # specify organization name that should be used for unauthenticated users
312 | ;org_name = Main Org.
313 | 
314 | # specify role for unauthenticated users
315 | ;org_role = Viewer
316 | 
317 | #################################### Github Auth ##########################
318 | [auth.github]
319 | ;enabled = false
320 | ;allow_sign_up = true
321 | ;client_id = some_id
322 | ;client_secret = some_secret
323 | ;scopes = user:email,read:org
324 | ;auth_url = https://github.com/login/oauth/authorize
325 | ;token_url = https://github.com/login/oauth/access_token
326 | ;api_url = https://api.github.com/user
327 | ;allowed_domains =
328 | ;team_ids =
329 | ;allowed_organizations =
330 | 
331 | #################################### GitLab Auth #########################
332 | [auth.gitlab]
333 | ;enabled = false
334 | ;allow_sign_up = true
335 | ;client_id = some_id
336 | ;client_secret = some_secret
337 | ;scopes = api
338 | ;auth_url = https://gitlab.com/oauth/authorize
339 | ;token_url = https://gitlab.com/oauth/token
340 | ;api_url = https://gitlab.com/api/v4
341 | ;allowed_domains =
342 | ;allowed_groups =
343 | 
344 | #################################### Google Auth ##########################
345 | [auth.google]
346 | ;enabled = false
347 | ;allow_sign_up = true
348 | ;client_id = some_client_id
349 | ;client_secret = some_client_secret
350 | ;scopes = https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email
351 | ;auth_url = https://accounts.google.com/o/oauth2/auth
352 | ;token_url = https://accounts.google.com/o/oauth2/token
353 | ;api_url = https://www.googleapis.com/oauth2/v1/userinfo
354 | ;allowed_domains =
355 | ;hosted_domain =
356 | 
357 | #################################### Grafana.com Auth ####################
358 | [auth.grafana_com]
359 | ;enabled = false
360 | ;allow_sign_up = true
361 | ;client_id = some_id
362 | ;client_secret = some_secret
363 | ;scopes = user:email
364 | ;allowed_organizations =
365 | 
366 | #################################### Azure AD OAuth #######################
367 | [auth.azuread]
368 | ;name = Azure AD
369 | ;enabled = false
370 | ;allow_sign_up = true
371 | ;client_id = some_client_id
372 | ;client_secret = some_client_secret
373 | ;scopes = openid email profile
374 | ;auth_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize
375 | ;token_url = https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/token
376 | ;allowed_domains =
377 | ;allowed_groups =
378 | 
379 | #################################### Okta OAuth #######################
380 | [auth.okta]
381 | ;name = Okta
382 | ;enabled = false
383 | ;allow_sign_up = true
384 | ;client_id = some_id
385 | ;client_secret = some_secret
386 | ;scopes = openid profile email groups
387 | ;auth_url = https://<tenant-id>.okta.com/oauth2/v1/authorize
388 | ;token_url = https://<tenant-id>.okta.com/oauth2/v1/token
389 | ;api_url = https://<tenant-id>.okta.com/oauth2/v1/userinfo
390 | ;allowed_domains =
391 | ;allowed_groups =
392 | ;role_attribute_path =
393 | 
394 | #################################### Generic OAuth ##########################
395 | [auth.generic_oauth]
396 | ;enabled = false
397 | ;name = OAuth
398 | ;allow_sign_up = true
399 | ;client_id = some_id
400 | ;client_secret = some_secret
401 | ;scopes = user:email,read:org
402 | ;email_attribute_name = email:primary
403 | ;email_attribute_path =
404 | ;auth_url = https://foo.bar/login/oauth/authorize
405 | ;token_url = https://foo.bar/login/oauth/access_token
406 | ;api_url = https://foo.bar/user
407 | ;allowed_domains =
408 | ;team_ids =
409 | ;allowed_organizations =
410 | ;role_attribute_path =
411 | ;tls_skip_verify_insecure = false
412 | ;tls_client_cert =
413 | ;tls_client_key =
414 | ;tls_client_ca =
415 | 
416 | #################################### Basic Auth ##########################
417 | [auth.basic]
418 | ;enabled = true
419 | 
420 | #################################### Auth Proxy ##########################
421 | [auth.proxy]
422 | ;enabled = false
423 | ;header_name = X-WEBAUTH-USER
424 | ;header_property = username
425 | ;auto_sign_up = true
426 | ;sync_ttl = 60
427 | ;whitelist = 192.168.1.1, 192.168.2.1
428 | ;headers = Email:X-User-Email, Name:X-User-Name
429 | # Read the auth proxy docs for details on what the setting below enables
430 | ;enable_login_token = false
431 | 
432 | #################################### Auth LDAP ##########################
433 | [auth.ldap]
434 | ;enabled = false
435 | ;config_file = /etc/grafana/ldap.toml
436 | ;allow_sign_up = true
437 | 
438 | # LDAP backround sync (Enterprise only)
439 | # At 1 am every day
440 | ;sync_cron = "0 0 1 * * *"
441 | ;active_sync_enabled = true
442 | 
443 | #################################### SMTP / Emailing ##########################
444 | [smtp]
445 | ;enabled = false
446 | ;host = localhost:25
447 | ;user =
448 | # If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;"""
449 | ;password =
450 | ;cert_file =
451 | ;key_file =
452 | ;skip_verify = false
453 | ;from_address = admin@grafana.localhost
454 | ;from_name = Grafana
455 | # EHLO identity in SMTP dialog (defaults to instance_name)
456 | ;ehlo_identity = dashboard.example.com
457 | 
458 | [emails]
459 | ;welcome_email_on_sign_up = false
460 | ;templates_pattern = emails/*.html
461 | 
462 | #################################### Logging ##########################
463 | [log]
464 | # Either "console", "file", "syslog". Default is console and  file
465 | # Use space to separate multiple modes, e.g. "console file"
466 | ;mode = console file
467 | 
468 | # Either "debug", "info", "warn", "error", "critical", default is "info"
469 | ;level = info
470 | 
471 | # optional settings to set different levels for specific loggers. Ex filters = sqlstore:debug
472 | ;filters =
473 | 
474 | # For "console" mode only
475 | [log.console]
476 | ;level =
477 | 
478 | # log line format, valid options are text, console and json
479 | ;format = console
480 | 
481 | # For "file" mode only
482 | [log.file]
483 | ;level =
484 | 
485 | # log line format, valid options are text, console and json
486 | ;format = text
487 | 
488 | # This enables automated log rotate(switch of following options), default is true
489 | ;log_rotate = true
490 | 
491 | # Max line number of single file, default is 1000000
492 | ;max_lines = 1000000
493 | 
494 | # Max size shift of single file, default is 28 means 1 << 28, 256MB
495 | ;max_size_shift = 28
496 | 
497 | # Segment log daily, default is true
498 | ;daily_rotate = true
499 | 
500 | # Expired days of log file(delete after max days), default is 7
501 | ;max_days = 7
502 | 
503 | [log.syslog]
504 | ;level =
505 | 
506 | # log line format, valid options are text, console and json
507 | ;format = text
508 | 
509 | # Syslog network type and address. This can be udp, tcp, or unix. If left blank, the default unix endpoints will be used.
510 | ;network =
511 | ;address =
512 | 
513 | # Syslog facility. user, daemon and local0 through local7 are valid.
514 | ;facility =
515 | 
516 | # Syslog tag. By default, the process' argv[0] is used.
517 | ;tag =
518 | 
519 | #################################### Usage Quotas ########################
520 | [quota]
521 | ; enabled = false
522 | 
523 | #### set quotas to -1 to make unlimited. ####
524 | # limit number of users per Org.
525 | ; org_user = 10
526 | 
527 | # limit number of dashboards per Org.
528 | ; org_dashboard = 100
529 | 
530 | # limit number of data_sources per Org.
531 | ; org_data_source = 10
532 | 
533 | # limit number of api_keys per Org.
534 | ; org_api_key = 10
535 | 
536 | # limit number of orgs a user can create.
537 | ; user_org = 10
538 | 
539 | # Global limit of users.
540 | ; global_user = -1
541 | 
542 | # global limit of orgs.
543 | ; global_org = -1
544 | 
545 | # global limit of dashboards
546 | ; global_dashboard = -1
547 | 
548 | # global limit of api_keys
549 | ; global_api_key = -1
550 | 
551 | # global limit on number of logged in users.
552 | ; global_session = -1
553 | 
554 | #################################### Alerting ############################
555 | [alerting]
556 | # Disable alerting engine & UI features
557 | ;enabled = true
558 | # Makes it possible to turn off alert rule execution but alerting UI is visible
559 | ;execute_alerts = true
560 | 
561 | # Default setting for new alert rules. Defaults to categorize error and timeouts as alerting. (alerting, keep_state)
562 | ;error_or_timeout = alerting
563 | 
564 | # Default setting for how Grafana handles nodata or null values in alerting. (alerting, no_data, keep_state, ok)
565 | ;nodata_or_nullvalues = no_data
566 | 
567 | # Alert notifications can include images, but rendering many images at the same time can overload the server
568 | # This limit will protect the server from render overloading and make sure notifications are sent out quickly
569 | ;concurrent_render_limit = 5
570 | 
571 | 
572 | # Default setting for alert calculation timeout. Default value is 30
573 | ;evaluation_timeout_seconds = 30
574 | 
575 | # Default setting for alert notification timeout. Default value is 30
576 | ;notification_timeout_seconds = 30
577 | 
578 | # Default setting for max attempts to sending alert notifications. Default value is 3
579 | ;max_attempts = 3
580 | 
581 | # Makes it possible to enforce a minimal interval between evaluations, to reduce load on the backend
582 | ;min_interval_seconds = 1
583 | 
584 | #################################### Explore #############################
585 | [explore]
586 | # Enable the Explore section
587 | ;enabled = true
588 | 
589 | #################################### Internal Grafana Metrics ##########################
590 | # Metrics available at HTTP API Url /metrics
591 | [metrics]
592 | # Disable / Enable internal metrics
593 | ;enabled           = true
594 | # Graphite Publish interval
595 | ;interval_seconds  = 10
596 | # Disable total stats (stat_totals_*) metrics to be generated
597 | ;disable_total_stats = false
598 | 
599 | #If both are set, basic auth will be required for the metrics endpoint.
600 | ; basic_auth_username =
601 | ; basic_auth_password =
602 | 
603 | # Send internal metrics to Graphite
604 | [metrics.graphite]
605 | # Enable by setting the address setting (ex localhost:2003)
606 | ;address =
607 | ;prefix = prod.grafana.%(instance_name)s.
608 | 
609 | #################################### Grafana.com integration  ##########################
610 | # Url used to import dashboards directly from Grafana.com
611 | [grafana_com]
612 | ;url = https://grafana.com
613 | 
614 | #################################### Distributed tracing ############
615 | [tracing.jaeger]
616 | # Enable by setting the address sending traces to jaeger (ex localhost:6831)
617 | ;address = localhost:6831
618 | # Tag that will always be included in when creating new spans. ex (tag1:value1,tag2:value2)
619 | ;always_included_tag = tag1:value1
620 | # Type specifies the type of the sampler: const, probabilistic, rateLimiting, or remote
621 | ;sampler_type = const
622 | # jaeger samplerconfig param
623 | # for "const" sampler, 0 or 1 for always false/true respectively
624 | # for "probabilistic" sampler, a probability between 0 and 1
625 | # for "rateLimiting" sampler, the number of spans per second
626 | # for "remote" sampler, param is the same as for "probabilistic"
627 | # and indicates the initial sampling rate before the actual one
628 | # is received from the mothership
629 | ;sampler_param = 1
630 | # Whether or not to use Zipkin propagation (x-b3- HTTP headers).
631 | ;zipkin_propagation = false
632 | # Setting this to true disables shared RPC spans.
633 | # Not disabling is the most common setting when using Zipkin elsewhere in your infrastructure.
634 | ;disable_shared_zipkin_spans = false
635 | 
636 | #################################### External image storage ##########################
637 | [external_image_storage]
638 | # Used for uploading images to public servers so they can be included in slack/email messages.
639 | # you can choose between (s3, webdav, gcs, azure_blob, local)
640 | ;provider =
641 | 
642 | [external_image_storage.s3]
643 | ;endpoint =
644 | ;path_style_access =
645 | ;bucket =
646 | ;region =
647 | ;path =
648 | ;access_key =
649 | ;secret_key =
650 | 
651 | [external_image_storage.webdav]
652 | ;url =
653 | ;public_url =
654 | ;username =
655 | ;password =
656 | 
657 | [external_image_storage.gcs]
658 | ;key_file =
659 | ;bucket =
660 | ;path =
661 | 
662 | [external_image_storage.azure_blob]
663 | ;account_name =
664 | ;account_key =
665 | ;container_name =
666 | 
667 | [external_image_storage.local]
668 | # does not require any configuration
669 | 
670 | [rendering]
671 | # Options to configure a remote HTTP image rendering service, e.g. using https://github.com/grafana/grafana-image-renderer.
672 | # URL to a remote HTTP image renderer service, e.g. http://localhost:8081/render, will enable Grafana to render panels and dashboards to PNG-images using HTTP requests to an external service.
673 | ;server_url =
674 | # If the remote HTTP image renderer service runs on a different server than the Grafana server you may have to configure this to a URL where Grafana is reachable, e.g. http://grafana.domain/.
675 | ;callback_url =
676 | # Concurrent render request limit affects when the /render HTTP endpoint is used. Rendering many images at the same time can overload the server,
677 | # which this setting can help protect against by only allowing a certain amount of concurrent requests.
678 | ;concurrent_render_request_limit = 30
679 | 
680 | [panels]
681 | # If set to true Grafana will allow script tags in text panels. Not recommended as it enable XSS vulnerabilities.
682 | ;disable_sanitize_html = false
683 | 
684 | [plugins]
685 | ;enable_alpha = false
686 | ;app_tls_skip_verify_insecure = false
687 | # Enter a comma-separated list of plugin identifiers to identify plugins that are allowed to be loaded even if they lack a valid signature.
688 | ;allow_loading_unsigned_plugins =
689 | 
690 | #################################### Grafana Image Renderer Plugin ##########################
691 | [plugin.grafana-image-renderer]
692 | # Instruct headless browser instance to use a default timezone when not provided by Grafana, e.g. when rendering panel image of alert.
693 | # See ICU’s metaZones.txt (https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt) for a list of supported
694 | # timezone IDs. Fallbacks to TZ environment variable if not set.
695 | ;rendering_timezone =
696 | 
697 | # Instruct headless browser instance to use a default language when not provided by Grafana, e.g. when rendering panel image of alert.
698 | # Please refer to the HTTP header Accept-Language to understand how to format this value, e.g. 'fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5'.
699 | ;rendering_language =
700 | 
701 | # Instruct headless browser instance to use a default device scale factor when not provided by Grafana, e.g. when rendering panel image of alert.
702 | # Default is 1. Using a higher value will produce more detailed images (higher DPI), but will require more disk space to store an image.
703 | ;rendering_viewport_device_scale_factor =
704 | 
705 | # Instruct headless browser instance whether to ignore HTTPS errors during navigation. Per default HTTPS errors are not ignored. Due to
706 | # the security risk it's not recommended to ignore HTTPS errors.
707 | ;rendering_ignore_https_errors =
708 | 
709 | # Instruct headless browser instance whether to capture and log verbose information when rendering an image. Default is false and will
710 | # only capture and log error messages. When enabled, debug messages are captured and logged as well.
711 | # For the verbose information to be included in the Grafana server log you have to adjust the rendering log level to debug, configure
712 | # [log].filter = rendering:debug.
713 | ;rendering_verbose_logging =
714 | 
715 | # Instruct headless browser instance whether to output its debug and error messages into running process of remote rendering service.
716 | # Default is false. This can be useful to enable (true) when troubleshooting.
717 | ;rendering_dumpio =
718 | 
719 | # Additional arguments to pass to the headless browser instance. Default is --no-sandbox. The list of Chromium flags can be found
720 | # here (https://peter.sh/experiments/chromium-command-line-switches/). Multiple arguments is separated with comma-character.
721 | ;rendering_args =
722 | 
723 | # You can configure the plugin to use a different browser binary instead of the pre-packaged version of Chromium.
724 | # Please note that this is not recommended, since you may encounter problems if the installed version of Chrome/Chromium is not
725 | # compatible with the plugin.
726 | ;rendering_chrome_bin =
727 | 
728 | # Instruct how headless browser instances are created. Default is 'default' and will create a new browser instance on each request.
729 | # Mode 'clustered' will make sure that only a maximum of browsers/incognito pages can execute concurrently.
730 | # Mode 'reusable' will have one browser instance and will create a new incognito page on each request.
731 | ;rendering_mode =
732 | 
733 | # When rendering_mode = clustered you can instruct how many browsers or incognito pages can execute concurrently. Default is 'browser'
734 | # and will cluster using browser instances.
735 | # Mode 'context' will cluster using incognito pages.
736 | ;rendering_clustering_mode =
737 | # When rendering_mode = clustered you can define maximum number of browser instances/incognito pages that can execute concurrently..
738 | ;rendering_clustering_max_concurrency =
739 | 
740 | # Limit the maxiumum viewport width, height and device scale factor that can be requested.
741 | ;rendering_viewport_max_width =
742 | ;rendering_viewport_max_height =
743 | ;rendering_viewport_max_device_scale_factor =
744 | 
745 | # Change the listening host and port of the gRPC server. Default host is 127.0.0.1 and default port is 0 and will automatically assign
746 | # a port not in use.
747 | ;grpc_host =
748 | ;grpc_port =
749 | 
750 | [enterprise]
751 | # Path to a valid Grafana Enterprise license.jwt file
752 | ;license_path =
753 | 
754 | [feature_toggles]
755 | # enable features, separated by spaces
756 | ;enable =
757 | 


--------------------------------------------------------------------------------
/grafana_conf/dashboards/apisix-grafana-dashboard.json:
--------------------------------------------------------------------------------
   1 | {
   2 |   "__inputs": [
   3 |     {
   4 |       "name": "DS_PROMETHEUS",
   5 |       "label": "Prometheus",
   6 |       "description": "",
   7 |       "type": "datasource",
   8 |       "pluginId": "prometheus",
   9 |       "pluginName": "Prometheus"
  10 |     }
  11 |   ],
  12 |   "__requires": [
  13 |     {
  14 |       "type": "grafana",
  15 |       "id": "grafana",
  16 |       "name": "Grafana",
  17 |       "version": "7.3.7"
  18 |     },
  19 |     {
  20 |       "type": "panel",
  21 |       "id": "graph",
  22 |       "name": "Graph",
  23 |       "version": ""
  24 |     },
  25 |     {
  26 |       "type": "datasource",
  27 |       "id": "prometheus",
  28 |       "name": "Prometheus",
  29 |       "version": "1.0.0"
  30 |     },
  31 |     {
  32 |       "type": "panel",
  33 |       "id": "singlestat",
  34 |       "name": "Singlestat",
  35 |       "version": ""
  36 |     },
  37 |     {
  38 |       "type": "panel",
  39 |       "id": "stat",
  40 |       "name": "Stat",
  41 |       "version": ""
  42 |     }
  43 |   ],
  44 |   "annotations": {
  45 |     "list": [
  46 |       {
  47 |         "builtIn": 1,
  48 |         "datasource": "${DS_PROMETHEUS}",
  49 |         "enable": true,
  50 |         "hide": true,
  51 |         "iconColor": "rgba(0, 211, 255, 1)",
  52 |         "limit": 100,
  53 |         "name": "Annotations & Alerts",
  54 |         "showIn": 0,
  55 |         "type": "dashboard"
  56 |       }
  57 |     ]
  58 |   },
  59 |   "description": "MicroService API Gateway Apache APISIX",
  60 |   "editable": true,
  61 |   "gnetId": 11719,
  62 |   "graphTooltip": 0,
  63 |   "id": null,
  64 |   "iteration": 1617695812393,
  65 |   "links": [],
  66 |   "panels": [
  67 |     {
  68 |       "collapsed": false,
  69 |       "datasource": "${DS_PROMETHEUS}",
  70 |       "gridPos": {
  71 |         "h": 1,
  72 |         "w": 24,
  73 |         "x": 0,
  74 |         "y": 0
  75 |       },
  76 |       "id": 10,
  77 |       "panels": [],
  78 |       "title": "Nginx",
  79 |       "type": "row"
  80 |     },
  81 |     {
  82 |       "cacheTimeout": null,
  83 |       "colorBackground": false,
  84 |       "colorValue": false,
  85 |       "colors": [
  86 |         "#299c46",
  87 |         "rgba(237, 129, 40, 0.89)",
  88 |         "#d44a3a"
  89 |       ],
  90 |       "datasource": "${DS_PROMETHEUS}",
  91 |       "description": "",
  92 |       "fieldConfig": {
  93 |         "defaults": {
  94 |           "custom": {}
  95 |         },
  96 |         "overrides": []
  97 |       },
  98 |       "format": "none",
  99 |       "gauge": {
 100 |         "maxValue": 100,
 101 |         "minValue": 0,
 102 |         "show": false,
 103 |         "thresholdLabels": false,
 104 |         "thresholdMarkers": true
 105 |       },
 106 |       "gridPos": {
 107 |         "h": 5,
 108 |         "w": 8,
 109 |         "x": 0,
 110 |         "y": 1
 111 |       },
 112 |       "id": 8,
 113 |       "interval": null,
 114 |       "links": [],
 115 |       "mappingType": 1,
 116 |       "mappingTypes": [
 117 |         {
 118 |           "name": "value to text",
 119 |           "value": 1
 120 |         },
 121 |         {
 122 |           "name": "range to text",
 123 |           "value": 2
 124 |         }
 125 |       ],
 126 |       "maxDataPoints": 100,
 127 |       "nullPointMode": "connected",
 128 |       "nullText": null,
 129 |       "postfix": "",
 130 |       "postfixFontSize": "50%",
 131 |       "prefix": "",
 132 |       "prefixFontSize": "50%",
 133 |       "rangeMaps": [
 134 |         {
 135 |           "from": "null",
 136 |           "text": "N/A",
 137 |           "to": "null"
 138 |         }
 139 |       ],
 140 |       "sparkline": {
 141 |         "fillColor": "rgba(31, 118, 189, 0.18)",
 142 |         "full": true,
 143 |         "lineColor": "rgb(31, 120, 193)",
 144 |         "show": true,
 145 |         "ymax": null,
 146 |         "ymin": null
 147 |       },
 148 |       "tableColumn": "",
 149 |       "targets": [
 150 |         {
 151 |           "expr": "sum(apisix_http_requests_total{instance=~\"$instance\"})",
 152 |           "intervalFactor": 2,
 153 |           "legendFormat": "Total",
 154 |           "refId": "A"
 155 |         }
 156 |       ],
 157 |       "thresholds": "",
 158 |       "timeFrom": null,
 159 |       "timeShift": null,
 160 |       "title": "Total Requests",
 161 |       "type": "singlestat",
 162 |       "valueFontSize": "80%",
 163 |       "valueMaps": [
 164 |         {
 165 |           "op": "=",
 166 |           "text": "N/A",
 167 |           "value": "null"
 168 |         }
 169 |       ],
 170 |       "valueName": "current"
 171 |     },
 172 |     {
 173 |       "cacheTimeout": null,
 174 |       "colorBackground": false,
 175 |       "colorValue": false,
 176 |       "colors": [
 177 |         "#299c46",
 178 |         "rgba(237, 129, 40, 0.89)",
 179 |         "#d44a3a"
 180 |       ],
 181 |       "datasource": "${DS_PROMETHEUS}",
 182 |       "description": "",
 183 |       "fieldConfig": {
 184 |         "defaults": {
 185 |           "custom": {}
 186 |         },
 187 |         "overrides": []
 188 |       },
 189 |       "format": "none",
 190 |       "gauge": {
 191 |         "maxValue": 100,
 192 |         "minValue": 0,
 193 |         "show": false,
 194 |         "thresholdLabels": false,
 195 |         "thresholdMarkers": true
 196 |       },
 197 |       "gridPos": {
 198 |         "h": 5,
 199 |         "w": 8,
 200 |         "x": 8,
 201 |         "y": 1
 202 |       },
 203 |       "id": 16,
 204 |       "interval": null,
 205 |       "links": [],
 206 |       "mappingType": 1,
 207 |       "mappingTypes": [
 208 |         {
 209 |           "name": "value to text",
 210 |           "value": 1
 211 |         },
 212 |         {
 213 |           "name": "range to text",
 214 |           "value": 2
 215 |         }
 216 |       ],
 217 |       "maxDataPoints": 100,
 218 |       "nullPointMode": "connected",
 219 |       "nullText": null,
 220 |       "postfix": "",
 221 |       "postfixFontSize": "50%",
 222 |       "prefix": "",
 223 |       "prefixFontSize": "50%",
 224 |       "rangeMaps": [
 225 |         {
 226 |           "from": "null",
 227 |           "text": "N/A",
 228 |           "to": "null"
 229 |         }
 230 |       ],
 231 |       "sparkline": {
 232 |         "fillColor": "rgba(31, 118, 189, 0.18)",
 233 |         "full": true,
 234 |         "lineColor": "rgb(31, 120, 193)",
 235 |         "show": true,
 236 |         "ymax": null,
 237 |         "ymin": null
 238 |       },
 239 |       "tableColumn": "",
 240 |       "targets": [
 241 |         {
 242 |           "expr": "sum(apisix_nginx_http_current_connections{state=\"accepted\", instance=~\"$instance\"})",
 243 |           "intervalFactor": 2,
 244 |           "legendFormat": "Accepted",
 245 |           "refId": "A"
 246 |         }
 247 |       ],
 248 |       "thresholds": "",
 249 |       "timeFrom": null,
 250 |       "timeShift": null,
 251 |       "title": "Accepted Connections",
 252 |       "type": "singlestat",
 253 |       "valueFontSize": "80%",
 254 |       "valueMaps": [
 255 |         {
 256 |           "op": "=",
 257 |           "text": "N/A",
 258 |           "value": "null"
 259 |         }
 260 |       ],
 261 |       "valueName": "current"
 262 |     },
 263 |     {
 264 |       "cacheTimeout": null,
 265 |       "colorBackground": false,
 266 |       "colorValue": false,
 267 |       "colors": [
 268 |         "#299c46",
 269 |         "rgba(237, 129, 40, 0.89)",
 270 |         "#d44a3a"
 271 |       ],
 272 |       "datasource": "${DS_PROMETHEUS}",
 273 |       "description": "",
 274 |       "fieldConfig": {
 275 |         "defaults": {
 276 |           "custom": {}
 277 |         },
 278 |         "overrides": []
 279 |       },
 280 |       "format": "none",
 281 |       "gauge": {
 282 |         "maxValue": 100,
 283 |         "minValue": 0,
 284 |         "show": false,
 285 |         "thresholdLabels": false,
 286 |         "thresholdMarkers": true
 287 |       },
 288 |       "gridPos": {
 289 |         "h": 5,
 290 |         "w": 8,
 291 |         "x": 16,
 292 |         "y": 1
 293 |       },
 294 |       "id": 11,
 295 |       "interval": null,
 296 |       "links": [],
 297 |       "mappingType": 1,
 298 |       "mappingTypes": [
 299 |         {
 300 |           "name": "value to text",
 301 |           "value": 1
 302 |         },
 303 |         {
 304 |           "name": "range to text",
 305 |           "value": 2
 306 |         }
 307 |       ],
 308 |       "maxDataPoints": 100,
 309 |       "nullPointMode": "connected",
 310 |       "nullText": null,
 311 |       "postfix": "",
 312 |       "postfixFontSize": "50%",
 313 |       "prefix": "",
 314 |       "prefixFontSize": "50%",
 315 |       "rangeMaps": [
 316 |         {
 317 |           "from": "null",
 318 |           "text": "N/A",
 319 |           "to": "null"
 320 |         }
 321 |       ],
 322 |       "sparkline": {
 323 |         "fillColor": "rgba(31, 118, 189, 0.18)",
 324 |         "full": true,
 325 |         "lineColor": "rgb(31, 120, 193)",
 326 |         "show": true,
 327 |         "ymax": null,
 328 |         "ymin": null
 329 |       },
 330 |       "tableColumn": "",
 331 |       "targets": [
 332 |         {
 333 |           "expr": "sum(apisix_nginx_http_current_connections{state=\"handled\", instance=~\"$instance\"})",
 334 |           "intervalFactor": 2,
 335 |           "legendFormat": "Total",
 336 |           "refId": "A"
 337 |         }
 338 |       ],
 339 |       "thresholds": "",
 340 |       "timeFrom": null,
 341 |       "timeShift": null,
 342 |       "title": "Handled Connections",
 343 |       "type": "singlestat",
 344 |       "valueFontSize": "80%",
 345 |       "valueMaps": [
 346 |         {
 347 |           "op": "=",
 348 |           "text": "N/A",
 349 |           "value": "null"
 350 |         }
 351 |       ],
 352 |       "valueName": "current"
 353 |     },
 354 |     {
 355 |       "aliasColors": {},
 356 |       "bars": false,
 357 |       "dashLength": 10,
 358 |       "dashes": false,
 359 |       "datasource": "${DS_PROMETHEUS}",
 360 |       "fieldConfig": {
 361 |         "defaults": {
 362 |           "custom": {},
 363 |           "links": []
 364 |         },
 365 |         "overrides": []
 366 |       },
 367 |       "fill": 1,
 368 |       "fillGradient": 0,
 369 |       "gridPos": {
 370 |         "h": 6,
 371 |         "w": 24,
 372 |         "x": 0,
 373 |         "y": 6
 374 |       },
 375 |       "hiddenSeries": false,
 376 |       "id": 17,
 377 |       "legend": {
 378 |         "alignAsTable": false,
 379 |         "avg": false,
 380 |         "current": false,
 381 |         "max": false,
 382 |         "min": false,
 383 |         "rightSide": false,
 384 |         "show": true,
 385 |         "total": false,
 386 |         "values": false
 387 |       },
 388 |       "lines": true,
 389 |       "linewidth": 1,
 390 |       "nullPointMode": "null",
 391 |       "options": {
 392 |         "alertThreshold": true
 393 |       },
 394 |       "percentage": false,
 395 |       "pluginVersion": "7.3.7",
 396 |       "pointradius": 2,
 397 |       "points": false,
 398 |       "renderer": "flot",
 399 |       "seriesOverrides": [],
 400 |       "spaceLength": 10,
 401 |       "stack": false,
 402 |       "steppedLine": false,
 403 |       "targets": [
 404 |         {
 405 |           "expr": "sum(apisix_nginx_http_current_connections{state=~\"active|reading|writing|waiting\", instance=~\"$instance\"}) by (state)",
 406 |           "instant": false,
 407 |           "interval": "",
 408 |           "intervalFactor": 1,
 409 |           "legendFormat": "{{state}}",
 410 |           "refId": "A"
 411 |         }
 412 |       ],
 413 |       "thresholds": [],
 414 |       "timeFrom": null,
 415 |       "timeRegions": [],
 416 |       "timeShift": null,
 417 |       "title": "Nginx connection state",
 418 |       "tooltip": {
 419 |         "shared": true,
 420 |         "sort": 0,
 421 |         "value_type": "individual"
 422 |       },
 423 |       "type": "graph",
 424 |       "xaxis": {
 425 |         "buckets": null,
 426 |         "mode": "time",
 427 |         "name": null,
 428 |         "show": true,
 429 |         "values": []
 430 |       },
 431 |       "yaxes": [
 432 |         {
 433 |           "decimals": null,
 434 |           "format": "short",
 435 |           "label": "",
 436 |           "logBase": 1,
 437 |           "max": null,
 438 |           "min": null,
 439 |           "show": true
 440 |         },
 441 |         {
 442 |           "decimals": null,
 443 |           "format": "Misc",
 444 |           "label": "",
 445 |           "logBase": 1,
 446 |           "max": null,
 447 |           "min": null,
 448 |           "show": true
 449 |         }
 450 |       ],
 451 |       "yaxis": {
 452 |         "align": false,
 453 |         "alignLevel": null
 454 |       }
 455 |     },
 456 |     {
 457 |       "collapsed": false,
 458 |       "datasource": "${DS_PROMETHEUS}",
 459 |       "gridPos": {
 460 |         "h": 1,
 461 |         "w": 24,
 462 |         "x": 0,
 463 |         "y": 12
 464 |       },
 465 |       "id": 13,
 466 |       "panels": [],
 467 |       "title": "Bandwidth",
 468 |       "type": "row"
 469 |     },
 470 |     {
 471 |       "aliasColors": {},
 472 |       "bars": false,
 473 |       "dashLength": 10,
 474 |       "dashes": false,
 475 |       "datasource": "${DS_PROMETHEUS}",
 476 |       "fieldConfig": {
 477 |         "defaults": {
 478 |           "custom": {},
 479 |           "links": []
 480 |         },
 481 |         "overrides": []
 482 |       },
 483 |       "fill": 1,
 484 |       "fillGradient": 0,
 485 |       "gridPos": {
 486 |         "h": 6,
 487 |         "w": 24,
 488 |         "x": 0,
 489 |         "y": 13
 490 |       },
 491 |       "hiddenSeries": false,
 492 |       "id": 6,
 493 |       "legend": {
 494 |         "alignAsTable": true,
 495 |         "avg": true,
 496 |         "current": true,
 497 |         "max": true,
 498 |         "min": true,
 499 |         "rightSide": true,
 500 |         "show": true,
 501 |         "sort": "total",
 502 |         "sortDesc": true,
 503 |         "total": true,
 504 |         "values": true
 505 |       },
 506 |       "lines": true,
 507 |       "linewidth": 1,
 508 |       "nullPointMode": "null",
 509 |       "options": {
 510 |         "alertThreshold": true
 511 |       },
 512 |       "percentage": false,
 513 |       "pluginVersion": "7.3.7",
 514 |       "pointradius": 2,
 515 |       "points": false,
 516 |       "renderer": "flot",
 517 |       "seriesOverrides": [],
 518 |       "spaceLength": 10,
 519 |       "stack": false,
 520 |       "steppedLine": false,
 521 |       "targets": [
 522 |         {
 523 |           "expr": "sum(rate(apisix_bandwidth{instance=~\"$instance\"}[30s])) by (type)",
 524 |           "legendFormat": "{{type}}",
 525 |           "refId": "A"
 526 |         }
 527 |       ],
 528 |       "thresholds": [],
 529 |       "timeFrom": null,
 530 |       "timeRegions": [],
 531 |       "timeShift": null,
 532 |       "title": "Total Bandwidth",
 533 |       "tooltip": {
 534 |         "shared": true,
 535 |         "sort": 0,
 536 |         "value_type": "individual"
 537 |       },
 538 |       "type": "graph",
 539 |       "xaxis": {
 540 |         "buckets": null,
 541 |         "mode": "time",
 542 |         "name": null,
 543 |         "show": true,
 544 |         "values": []
 545 |       },
 546 |       "yaxes": [
 547 |         {
 548 |           "decimals": 0,
 549 |           "format": "decbytes",
 550 |           "label": null,
 551 |           "logBase": 1,
 552 |           "max": null,
 553 |           "min": "0",
 554 |           "show": true
 555 |         },
 556 |         {
 557 |           "format": "short",
 558 |           "label": null,
 559 |           "logBase": 1,
 560 |           "max": null,
 561 |           "min": null,
 562 |           "show": true
 563 |         }
 564 |       ],
 565 |       "yaxis": {
 566 |         "align": false,
 567 |         "alignLevel": null
 568 |       }
 569 |     },
 570 |     {
 571 |       "aliasColors": {},
 572 |       "bars": false,
 573 |       "dashLength": 10,
 574 |       "dashes": false,
 575 |       "datasource": "${DS_PROMETHEUS}",
 576 |       "fieldConfig": {
 577 |         "defaults": {
 578 |           "custom": {},
 579 |           "links": []
 580 |         },
 581 |         "overrides": []
 582 |       },
 583 |       "fill": 1,
 584 |       "fillGradient": 0,
 585 |       "gridPos": {
 586 |         "h": 6,
 587 |         "w": 24,
 588 |         "x": 0,
 589 |         "y": 19
 590 |       },
 591 |       "hiddenSeries": false,
 592 |       "id": 21,
 593 |       "legend": {
 594 |         "alignAsTable": true,
 595 |         "avg": true,
 596 |         "current": true,
 597 |         "max": true,
 598 |         "min": true,
 599 |         "rightSide": true,
 600 |         "show": true,
 601 |         "sort": "total",
 602 |         "sortDesc": true,
 603 |         "total": true,
 604 |         "values": true
 605 |       },
 606 |       "lines": true,
 607 |       "linewidth": 1,
 608 |       "nullPointMode": "null",
 609 |       "options": {
 610 |         "alertThreshold": true
 611 |       },
 612 |       "percentage": false,
 613 |       "pluginVersion": "7.3.7",
 614 |       "pointradius": 2,
 615 |       "points": false,
 616 |       "renderer": "flot",
 617 |       "seriesOverrides": [],
 618 |       "spaceLength": 10,
 619 |       "stack": false,
 620 |       "steppedLine": false,
 621 |       "targets": [
 622 |         {
 623 |           "expr": "sum(irate(apisix_bandwidth{type=\"ingress\", service =~\"$service\",route=~\"$route\",instance=~\"$instance\"}[1m])) by (service)",
 624 |           "legendFormat": "service:{{service}}",
 625 |           "refId": "A"
 626 |         },
 627 |         {
 628 |           "expr": "sum(irate(apisix_bandwidth{type=\"ingress\", service =~\"$service\",route=~\"$route\",instance=~\"$instance\"}[1m])) by (route)",
 629 |           "legendFormat": "route:{{route}}",
 630 |           "refId": "B"
 631 |         }
 632 |       ],
 633 |       "thresholds": [],
 634 |       "timeFrom": null,
 635 |       "timeRegions": [],
 636 |       "timeShift": null,
 637 |       "title": "Ingress per service/route",
 638 |       "tooltip": {
 639 |         "shared": true,
 640 |         "sort": 0,
 641 |         "value_type": "individual"
 642 |       },
 643 |       "type": "graph",
 644 |       "xaxis": {
 645 |         "buckets": null,
 646 |         "mode": "time",
 647 |         "name": null,
 648 |         "show": true,
 649 |         "values": []
 650 |       },
 651 |       "yaxes": [
 652 |         {
 653 |           "decimals": 0,
 654 |           "format": "decbytes",
 655 |           "label": null,
 656 |           "logBase": 1,
 657 |           "max": null,
 658 |           "min": "0",
 659 |           "show": true
 660 |         },
 661 |         {
 662 |           "format": "short",
 663 |           "label": null,
 664 |           "logBase": 1,
 665 |           "max": null,
 666 |           "min": null,
 667 |           "show": true
 668 |         }
 669 |       ],
 670 |       "yaxis": {
 671 |         "align": false,
 672 |         "alignLevel": null
 673 |       }
 674 |     },
 675 |     {
 676 |       "aliasColors": {},
 677 |       "bars": false,
 678 |       "dashLength": 10,
 679 |       "dashes": false,
 680 |       "datasource": "${DS_PROMETHEUS}",
 681 |       "fieldConfig": {
 682 |         "defaults": {
 683 |           "custom": {},
 684 |           "links": []
 685 |         },
 686 |         "overrides": []
 687 |       },
 688 |       "fill": 1,
 689 |       "fillGradient": 0,
 690 |       "gridPos": {
 691 |         "h": 6,
 692 |         "w": 24,
 693 |         "x": 0,
 694 |         "y": 25
 695 |       },
 696 |       "hiddenSeries": false,
 697 |       "id": 19,
 698 |       "legend": {
 699 |         "alignAsTable": true,
 700 |         "avg": true,
 701 |         "current": true,
 702 |         "max": true,
 703 |         "min": true,
 704 |         "rightSide": true,
 705 |         "show": true,
 706 |         "sort": "total",
 707 |         "sortDesc": true,
 708 |         "total": true,
 709 |         "values": true
 710 |       },
 711 |       "lines": true,
 712 |       "linewidth": 1,
 713 |       "nullPointMode": "null",
 714 |       "options": {
 715 |         "alertThreshold": true
 716 |       },
 717 |       "percentage": false,
 718 |       "pluginVersion": "7.3.7",
 719 |       "pointradius": 2,
 720 |       "points": false,
 721 |       "renderer": "flot",
 722 |       "seriesOverrides": [],
 723 |       "spaceLength": 10,
 724 |       "stack": false,
 725 |       "steppedLine": false,
 726 |       "targets": [
 727 |         {
 728 |           "expr": "sum(rate(apisix_bandwidth{type=\"egress\", service =~\"$service\",route=~\"$route\",instance=~\"$instance\"}[1m])) by (service)",
 729 |           "interval": "",
 730 |           "legendFormat": "service:{{service}}",
 731 |           "refId": "A"
 732 |         },
 733 |         {
 734 |           "expr": "sum(rate(apisix_bandwidth{type=\"egress\", service =~\"$service\",route=~\"$route\",instance=~\"$instance\"}[1m])) by (route)",
 735 |           "legendFormat": "route:{{route}}",
 736 |           "refId": "B"
 737 |         }
 738 |       ],
 739 |       "thresholds": [],
 740 |       "timeFrom": null,
 741 |       "timeRegions": [],
 742 |       "timeShift": null,
 743 |       "title": "Egress per service/route",
 744 |       "tooltip": {
 745 |         "shared": true,
 746 |         "sort": 0,
 747 |         "value_type": "individual"
 748 |       },
 749 |       "type": "graph",
 750 |       "xaxis": {
 751 |         "buckets": null,
 752 |         "mode": "time",
 753 |         "name": null,
 754 |         "show": true,
 755 |         "values": []
 756 |       },
 757 |       "yaxes": [
 758 |         {
 759 |           "decimals": 0,
 760 |           "format": "decbytes",
 761 |           "label": null,
 762 |           "logBase": 1,
 763 |           "max": null,
 764 |           "min": "0",
 765 |           "show": true
 766 |         },
 767 |         {
 768 |           "format": "short",
 769 |           "label": null,
 770 |           "logBase": 1,
 771 |           "max": null,
 772 |           "min": null,
 773 |           "show": true
 774 |         }
 775 |       ],
 776 |       "yaxis": {
 777 |         "align": false,
 778 |         "alignLevel": null
 779 |       }
 780 |     },
 781 |     {
 782 |       "collapsed": false,
 783 |       "datasource": "${DS_PROMETHEUS}",
 784 |       "gridPos": {
 785 |         "h": 1,
 786 |         "w": 24,
 787 |         "x": 0,
 788 |         "y": 31
 789 |       },
 790 |       "id": 15,
 791 |       "panels": [],
 792 |       "title": "HTTP",
 793 |       "type": "row"
 794 |     },
 795 |     {
 796 |       "aliasColors": {
 797 |         "HTTP Status:200": "green",
 798 |         "HTTP Status:500": "red"
 799 |       },
 800 |       "bars": false,
 801 |       "cacheTimeout": null,
 802 |       "dashLength": 10,
 803 |       "dashes": false,
 804 |       "datasource": "${DS_PROMETHEUS}",
 805 |       "description": "",
 806 |       "fieldConfig": {
 807 |         "defaults": {
 808 |           "custom": {},
 809 |           "links": []
 810 |         },
 811 |         "overrides": []
 812 |       },
 813 |       "fill": 3,
 814 |       "fillGradient": 0,
 815 |       "gridPos": {
 816 |         "h": 6,
 817 |         "w": 24,
 818 |         "x": 0,
 819 |         "y": 32
 820 |       },
 821 |       "hiddenSeries": false,
 822 |       "id": 2,
 823 |       "interval": "",
 824 |       "legend": {
 825 |         "avg": false,
 826 |         "current": false,
 827 |         "max": false,
 828 |         "min": false,
 829 |         "show": true,
 830 |         "total": false,
 831 |         "values": false
 832 |       },
 833 |       "lines": true,
 834 |       "linewidth": 1,
 835 |       "links": [],
 836 |       "nullPointMode": "null",
 837 |       "options": {
 838 |         "alertThreshold": true
 839 |       },
 840 |       "percentage": false,
 841 |       "pluginVersion": "7.3.7",
 842 |       "pointradius": 2,
 843 |       "points": false,
 844 |       "renderer": "flot",
 845 |       "seriesOverrides": [
 846 |         {
 847 |           "alias": "state",
 848 |           "lines": true
 849 |         }
 850 |       ],
 851 |       "spaceLength": 10,
 852 |       "stack": false,
 853 |       "steppedLine": false,
 854 |       "targets": [
 855 |         {
 856 |           "expr": "sum(rate(apisix_http_status{service=~\"$service\",route=~\"$route\",instance=~\"$instance\"}[1m])) by (code)",
 857 |           "instant": false,
 858 |           "interval": "",
 859 |           "intervalFactor": 1,
 860 |           "legendFormat": "HTTP Status:{{code}}",
 861 |           "refId": "A"
 862 |         }
 863 |       ],
 864 |       "thresholds": [],
 865 |       "timeFrom": null,
 866 |       "timeRegions": [],
 867 |       "timeShift": null,
 868 |       "title": "Requests per second (RPS) by status code",
 869 |       "tooltip": {
 870 |         "shared": true,
 871 |         "sort": 0,
 872 |         "value_type": "individual"
 873 |       },
 874 |       "type": "graph",
 875 |       "xaxis": {
 876 |         "buckets": null,
 877 |         "mode": "time",
 878 |         "name": null,
 879 |         "show": true,
 880 |         "values": []
 881 |       },
 882 |       "yaxes": [
 883 |         {
 884 |           "decimals": 0,
 885 |           "format": "short",
 886 |           "label": null,
 887 |           "logBase": 1,
 888 |           "max": null,
 889 |           "min": "0",
 890 |           "show": true
 891 |         },
 892 |         {
 893 |           "format": "short",
 894 |           "label": null,
 895 |           "logBase": 1,
 896 |           "max": null,
 897 |           "min": null,
 898 |           "show": true
 899 |         }
 900 |       ],
 901 |       "yaxis": {
 902 |         "align": false,
 903 |         "alignLevel": null
 904 |       }
 905 |     },
 906 |     {
 907 |       "aliasColors": {},
 908 |       "bars": false,
 909 |       "cacheTimeout": null,
 910 |       "dashLength": 10,
 911 |       "dashes": false,
 912 |       "datasource": "${DS_PROMETHEUS}",
 913 |       "description": "",
 914 |       "fieldConfig": {
 915 |         "defaults": {
 916 |           "custom": {},
 917 |           "links": []
 918 |         },
 919 |         "overrides": []
 920 |       },
 921 |       "fill": 3,
 922 |       "fillGradient": 0,
 923 |       "gridPos": {
 924 |         "h": 6,
 925 |         "w": 24,
 926 |         "x": 0,
 927 |         "y": 38
 928 |       },
 929 |       "hiddenSeries": false,
 930 |       "id": 32,
 931 |       "interval": "",
 932 |       "legend": {
 933 |         "alignAsTable": true,
 934 |         "avg": true,
 935 |         "current": true,
 936 |         "max": true,
 937 |         "min": true,
 938 |         "rightSide": true,
 939 |         "show": true,
 940 |         "sort": "total",
 941 |         "sortDesc": true,
 942 |         "total": true,
 943 |         "values": true
 944 |       },
 945 |       "lines": true,
 946 |       "linewidth": 1,
 947 |       "links": [],
 948 |       "nullPointMode": "null",
 949 |       "options": {
 950 |         "alertThreshold": true
 951 |       },
 952 |       "percentage": false,
 953 |       "pluginVersion": "7.3.7",
 954 |       "pointradius": 2,
 955 |       "points": false,
 956 |       "renderer": "flot",
 957 |       "seriesOverrides": [
 958 |         {
 959 |           "alias": "state",
 960 |           "lines": true
 961 |         }
 962 |       ],
 963 |       "spaceLength": 10,
 964 |       "stack": false,
 965 |       "steppedLine": false,
 966 |       "targets": [
 967 |         {
 968 |           "expr": "sum(rate(apisix_http_status{service=~\"$service\",route=~\"$route\",instance=~\"$instance\"}[1m])) by (service)",
 969 |           "instant": false,
 970 |           "interval": "",
 971 |           "intervalFactor": 1,
 972 |           "legendFormat": "service:{{service}}",
 973 |           "refId": "A"
 974 |         },
 975 |         {
 976 |           "expr": "sum(rate(apisix_http_status{service=~\"$service\",route=~\"$route\",instance=~\"$instance\"}[1m])) by (route)",
 977 |           "interval": "",
 978 |           "legendFormat": "route:{{route}}",
 979 |           "refId": "D"
 980 |         }
 981 |       ],
 982 |       "thresholds": [],
 983 |       "timeFrom": null,
 984 |       "timeRegions": [],
 985 |       "timeShift": null,
 986 |       "title": "Requests per second (RPS) per service/route",
 987 |       "tooltip": {
 988 |         "shared": true,
 989 |         "sort": 0,
 990 |         "value_type": "individual"
 991 |       },
 992 |       "type": "graph",
 993 |       "xaxis": {
 994 |         "buckets": null,
 995 |         "mode": "time",
 996 |         "name": null,
 997 |         "show": true,
 998 |         "values": []
 999 |       },
1000 |       "yaxes": [
1001 |         {
1002 |           "decimals": 0,
1003 |           "format": "short",
1004 |           "label": null,
1005 |           "logBase": 1,
1006 |           "max": null,
1007 |           "min": "0",
1008 |           "show": true
1009 |         },
1010 |         {
1011 |           "format": "short",
1012 |           "label": null,
1013 |           "logBase": 1,
1014 |           "max": null,
1015 |           "min": null,
1016 |           "show": true
1017 |         }
1018 |       ],
1019 |       "yaxis": {
1020 |         "align": false,
1021 |         "alignLevel": null
1022 |       }
1023 |     },
1024 |     {
1025 |       "aliasColors": {},
1026 |       "bars": false,
1027 |       "dashLength": 10,
1028 |       "dashes": false,
1029 |       "datasource": "${DS_PROMETHEUS}",
1030 |       "fieldConfig": {
1031 |         "defaults": {
1032 |           "custom": {},
1033 |           "mappings": [],
1034 |           "thresholds": {
1035 |             "mode": "absolute",
1036 |             "steps": [
1037 |               {
1038 |                 "color": "green",
1039 |                 "value": null
1040 |               },
1041 |               {
1042 |                 "color": "red",
1043 |                 "value": 80
1044 |               }
1045 |             ]
1046 |           }
1047 |         },
1048 |         "overrides": []
1049 |       },
1050 |       "fill": 1,
1051 |       "fillGradient": 0,
1052 |       "gridPos": {
1053 |         "h": 6,
1054 |         "w": 8,
1055 |         "x": 0,
1056 |         "y": 44
1057 |       },
1058 |       "hiddenSeries": false,
1059 |       "id": 27,
1060 |       "legend": {
1061 |         "avg": false,
1062 |         "current": false,
1063 |         "max": false,
1064 |         "min": false,
1065 |         "show": true,
1066 |         "total": false,
1067 |         "values": false
1068 |       },
1069 |       "lines": true,
1070 |       "linewidth": 1,
1071 |       "nullPointMode": "null",
1072 |       "options": {
1073 |         "alertThreshold": true
1074 |       },
1075 |       "percentage": false,
1076 |       "pluginVersion": "7.3.7",
1077 |       "pointradius": 2,
1078 |       "points": false,
1079 |       "renderer": "flot",
1080 |       "seriesOverrides": [],
1081 |       "spaceLength": 10,
1082 |       "stack": false,
1083 |       "steppedLine": false,
1084 |       "targets": [
1085 |         {
1086 |           "expr": "histogram_quantile(0.90, sum(rate(apisix_http_latency_bucket{type=~\"request\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1087 |           "format": "time_series",
1088 |           "interval": "",
1089 |           "legendFormat": "P90",
1090 |           "refId": "A"
1091 |         },
1092 |         {
1093 |           "expr": "histogram_quantile(0.95, sum(rate(apisix_http_latency_bucket{type=~\"request\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1094 |           "interval": "",
1095 |           "legendFormat": "P95",
1096 |           "refId": "B"
1097 |         },
1098 |         {
1099 |           "expr": "histogram_quantile(0.99, sum(rate(apisix_http_latency_bucket{type=~\"request\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1100 |           "interval": "",
1101 |           "legendFormat": "P99",
1102 |           "refId": "C"
1103 |         }
1104 |       ],
1105 |       "thresholds": [],
1106 |       "timeFrom": null,
1107 |       "timeRegions": [],
1108 |       "timeShift": null,
1109 |       "title": "Request Latency",
1110 |       "tooltip": {
1111 |         "shared": true,
1112 |         "sort": 0,
1113 |         "value_type": "individual"
1114 |       },
1115 |       "type": "graph",
1116 |       "xaxis": {
1117 |         "buckets": null,
1118 |         "mode": "time",
1119 |         "name": null,
1120 |         "show": true,
1121 |         "values": []
1122 |       },
1123 |       "yaxes": [
1124 |         {
1125 |           "format": "ms",
1126 |           "label": "",
1127 |           "logBase": 1,
1128 |           "max": null,
1129 |           "min": null,
1130 |           "show": true
1131 |         },
1132 |         {
1133 |           "format": "short",
1134 |           "label": null,
1135 |           "logBase": 1,
1136 |           "max": null,
1137 |           "min": null,
1138 |           "show": true
1139 |         }
1140 |       ],
1141 |       "yaxis": {
1142 |         "align": false,
1143 |         "alignLevel": null
1144 |       }
1145 |     },
1146 |     {
1147 |       "aliasColors": {},
1148 |       "bars": false,
1149 |       "dashLength": 10,
1150 |       "dashes": false,
1151 |       "datasource": "${DS_PROMETHEUS}",
1152 |       "description": "",
1153 |       "fieldConfig": {
1154 |         "defaults": {
1155 |           "custom": {},
1156 |           "mappings": [],
1157 |           "thresholds": {
1158 |             "mode": "absolute",
1159 |             "steps": [
1160 |               {
1161 |                 "color": "green",
1162 |                 "value": null
1163 |               },
1164 |               {
1165 |                 "color": "red",
1166 |                 "value": 80
1167 |               }
1168 |             ]
1169 |           }
1170 |         },
1171 |         "overrides": []
1172 |       },
1173 |       "fill": 1,
1174 |       "fillGradient": 0,
1175 |       "gridPos": {
1176 |         "h": 6,
1177 |         "w": 8,
1178 |         "x": 8,
1179 |         "y": 44
1180 |       },
1181 |       "hiddenSeries": false,
1182 |       "id": 28,
1183 |       "legend": {
1184 |         "avg": false,
1185 |         "current": false,
1186 |         "max": false,
1187 |         "min": false,
1188 |         "show": true,
1189 |         "total": false,
1190 |         "values": false
1191 |       },
1192 |       "lines": true,
1193 |       "linewidth": 1,
1194 |       "nullPointMode": "null",
1195 |       "options": {
1196 |         "alertThreshold": true
1197 |       },
1198 |       "percentage": false,
1199 |       "pluginVersion": "7.3.7",
1200 |       "pointradius": 2,
1201 |       "points": false,
1202 |       "renderer": "flot",
1203 |       "seriesOverrides": [],
1204 |       "spaceLength": 10,
1205 |       "stack": false,
1206 |       "steppedLine": false,
1207 |       "targets": [
1208 |         {
1209 |           "expr": "histogram_quantile(0.90, sum(rate(apisix_http_latency_bucket{type=~\"apisix\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1210 |           "format": "time_series",
1211 |           "instant": false,
1212 |           "interval": "",
1213 |           "intervalFactor": 1,
1214 |           "legendFormat": "P90",
1215 |           "refId": "A"
1216 |         },
1217 |         {
1218 |           "expr": "histogram_quantile(0.95, sum(rate(apisix_http_latency_bucket{type=~\"apisix\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1219 |           "interval": "",
1220 |           "legendFormat": "P95",
1221 |           "refId": "B"
1222 |         },
1223 |         {
1224 |           "expr": "histogram_quantile(0.99, sum(rate(apisix_http_latency_bucket{type=~\"apisix\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1225 |           "interval": "",
1226 |           "legendFormat": "P99",
1227 |           "refId": "C"
1228 |         }
1229 |       ],
1230 |       "thresholds": [],
1231 |       "timeFrom": null,
1232 |       "timeRegions": [],
1233 |       "timeShift": null,
1234 |       "title": "APISIX Latency",
1235 |       "tooltip": {
1236 |         "shared": true,
1237 |         "sort": 0,
1238 |         "value_type": "individual"
1239 |       },
1240 |       "type": "graph",
1241 |       "xaxis": {
1242 |         "buckets": null,
1243 |         "mode": "time",
1244 |         "name": null,
1245 |         "show": true,
1246 |         "values": []
1247 |       },
1248 |       "yaxes": [
1249 |         {
1250 |           "format": "ms",
1251 |           "label": null,
1252 |           "logBase": 1,
1253 |           "max": null,
1254 |           "min": null,
1255 |           "show": true
1256 |         },
1257 |         {
1258 |           "format": "short",
1259 |           "label": null,
1260 |           "logBase": 1,
1261 |           "max": null,
1262 |           "min": null,
1263 |           "show": true
1264 |         }
1265 |       ],
1266 |       "yaxis": {
1267 |         "align": false,
1268 |         "alignLevel": null
1269 |       }
1270 |     },
1271 |     {
1272 |       "aliasColors": {},
1273 |       "bars": false,
1274 |       "dashLength": 10,
1275 |       "dashes": false,
1276 |       "datasource": "${DS_PROMETHEUS}",
1277 |       "fieldConfig": {
1278 |         "defaults": {
1279 |           "custom": {},
1280 |           "mappings": [],
1281 |           "thresholds": {
1282 |             "mode": "absolute",
1283 |             "steps": [
1284 |               {
1285 |                 "color": "green",
1286 |                 "value": null
1287 |               },
1288 |               {
1289 |                 "color": "red",
1290 |                 "value": 80
1291 |               }
1292 |             ]
1293 |           }
1294 |         },
1295 |         "overrides": []
1296 |       },
1297 |       "fill": 1,
1298 |       "fillGradient": 0,
1299 |       "gridPos": {
1300 |         "h": 6,
1301 |         "w": 8,
1302 |         "x": 16,
1303 |         "y": 44
1304 |       },
1305 |       "hiddenSeries": false,
1306 |       "id": 33,
1307 |       "legend": {
1308 |         "avg": false,
1309 |         "current": false,
1310 |         "max": false,
1311 |         "min": false,
1312 |         "show": true,
1313 |         "total": false,
1314 |         "values": false
1315 |       },
1316 |       "lines": true,
1317 |       "linewidth": 1,
1318 |       "nullPointMode": "null",
1319 |       "options": {
1320 |         "alertThreshold": true
1321 |       },
1322 |       "percentage": false,
1323 |       "pluginVersion": "7.3.7",
1324 |       "pointradius": 2,
1325 |       "points": false,
1326 |       "renderer": "flot",
1327 |       "seriesOverrides": [],
1328 |       "spaceLength": 10,
1329 |       "stack": false,
1330 |       "steppedLine": false,
1331 |       "targets": [
1332 |         {
1333 |           "expr": "histogram_quantile(0.90, sum(rate(apisix_http_latency_bucket{type=~\"upstream\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1334 |           "format": "time_series",
1335 |           "interval": "",
1336 |           "legendFormat": "P90",
1337 |           "refId": "A"
1338 |         },
1339 |         {
1340 |           "expr": "histogram_quantile(0.95, sum(rate(apisix_http_latency_bucket{type=~\"upstream\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1341 |           "interval": "",
1342 |           "legendFormat": "P95",
1343 |           "refId": "B"
1344 |         },
1345 |         {
1346 |           "expr": "histogram_quantile(0.99, sum(rate(apisix_http_latency_bucket{type=~\"upstream\",service=~\"$service\",consumer=~\"$consumer\",node=~\"$node\"}[1m])) by (le))",
1347 |           "interval": "",
1348 |           "legendFormat": "P99",
1349 |           "refId": "C"
1350 |         }
1351 |       ],
1352 |       "thresholds": [],
1353 |       "timeFrom": null,
1354 |       "timeRegions": [],
1355 |       "timeShift": null,
1356 |       "title": "Upstream Latency",
1357 |       "tooltip": {
1358 |         "shared": true,
1359 |         "sort": 0,
1360 |         "value_type": "individual"
1361 |       },
1362 |       "type": "graph",
1363 |       "xaxis": {
1364 |         "buckets": null,
1365 |         "mode": "time",
1366 |         "name": null,
1367 |         "show": true,
1368 |         "values": []
1369 |       },
1370 |       "yaxes": [
1371 |         {
1372 |           "format": "ms",
1373 |           "label": "",
1374 |           "logBase": 1,
1375 |           "max": null,
1376 |           "min": null,
1377 |           "show": true
1378 |         },
1379 |         {
1380 |           "format": "short",
1381 |           "label": null,
1382 |           "logBase": 1,
1383 |           "max": null,
1384 |           "min": null,
1385 |           "show": true
1386 |         }
1387 |       ],
1388 |       "yaxis": {
1389 |         "align": false,
1390 |         "alignLevel": null
1391 |       }
1392 |     },
1393 |     {
1394 |       "collapsed": false,
1395 |       "datasource": "${DS_PROMETHEUS}",
1396 |       "gridPos": {
1397 |         "h": 1,
1398 |         "w": 24,
1399 |         "x": 0,
1400 |         "y": 50
1401 |       },
1402 |       "id": 23,
1403 |       "panels": [],
1404 |       "title": "Misc",
1405 |       "type": "row"
1406 |     },
1407 |     {
1408 |       "aliasColors": {},
1409 |       "bars": false,
1410 |       "dashLength": 10,
1411 |       "dashes": false,
1412 |       "datasource": "${DS_PROMETHEUS}",
1413 |       "fieldConfig": {
1414 |         "defaults": {
1415 |           "custom": {},
1416 |           "links": []
1417 |         },
1418 |         "overrides": []
1419 |       },
1420 |       "fill": 1,
1421 |       "fillGradient": 0,
1422 |       "gridPos": {
1423 |         "h": 6,
1424 |         "w": 18,
1425 |         "x": 0,
1426 |         "y": 51
1427 |       },
1428 |       "hiddenSeries": false,
1429 |       "id": 30,
1430 |       "legend": {
1431 |         "alignAsTable": false,
1432 |         "avg": false,
1433 |         "current": false,
1434 |         "max": false,
1435 |         "min": false,
1436 |         "rightSide": false,
1437 |         "show": true,
1438 |         "total": false,
1439 |         "values": false
1440 |       },
1441 |       "lines": true,
1442 |       "linewidth": 1,
1443 |       "nullPointMode": "null",
1444 |       "options": {
1445 |         "alertThreshold": true
1446 |       },
1447 |       "percentage": false,
1448 |       "pluginVersion": "7.3.7",
1449 |       "pointradius": 2,
1450 |       "points": false,
1451 |       "renderer": "flot",
1452 |       "seriesOverrides": [],
1453 |       "spaceLength": 10,
1454 |       "stack": false,
1455 |       "steppedLine": false,
1456 |       "targets": [
1457 |         {
1458 |           "expr": "sum(apisix_etcd_modify_indexes{key=~\"consumers|global_rules|max_modify_index|prev_index|protos|routes|services|ssls|stream_routes|upstreams|x_etcd_index\"}) by (key)",
1459 |           "interval": "",
1460 |           "intervalFactor": 1,
1461 |           "legendFormat": "{{key}}",
1462 |           "refId": "A"
1463 |         }
1464 |       ],
1465 |       "thresholds": [],
1466 |       "timeFrom": null,
1467 |       "timeRegions": [],
1468 |       "timeShift": null,
1469 |       "title": "Etcd modify indexes",
1470 |       "tooltip": {
1471 |         "shared": true,
1472 |         "sort": 0,
1473 |         "value_type": "individual"
1474 |       },
1475 |       "type": "graph",
1476 |       "xaxis": {
1477 |         "buckets": null,
1478 |         "mode": "time",
1479 |         "name": null,
1480 |         "show": true,
1481 |         "values": []
1482 |       },
1483 |       "yaxes": [
1484 |         {
1485 |           "decimals": 0,
1486 |           "format": "short",
1487 |           "label": "",
1488 |           "logBase": 1,
1489 |           "max": null,
1490 |           "min": null,
1491 |           "show": true
1492 |         },
1493 |         {
1494 |           "decimals": null,
1495 |           "format": "short",
1496 |           "label": "",
1497 |           "logBase": 1,
1498 |           "max": null,
1499 |           "min": null,
1500 |           "show": true
1501 |         }
1502 |       ],
1503 |       "yaxis": {
1504 |         "align": false,
1505 |         "alignLevel": null
1506 |       }
1507 |     },
1508 |     {
1509 |       "datasource": "${DS_PROMETHEUS}",
1510 |       "fieldConfig": {
1511 |         "defaults": {
1512 |           "custom": {},
1513 |           "mappings": [],
1514 |           "thresholds": {
1515 |             "mode": "absolute",
1516 |             "steps": [
1517 |               {
1518 |                 "color": "green",
1519 |                 "value": null
1520 |               },
1521 |               {
1522 |                 "color": "red",
1523 |                 "value": 0
1524 |               },
1525 |               {
1526 |                 "color": "green",
1527 |                 "value": 1
1528 |               }
1529 |             ]
1530 |           }
1531 |         },
1532 |         "overrides": []
1533 |       },
1534 |       "gridPos": {
1535 |         "h": 6,
1536 |         "w": 3,
1537 |         "x": 18,
1538 |         "y": 51
1539 |       },
1540 |       "id": 25,
1541 |       "options": {
1542 |         "colorMode": "value",
1543 |         "graphMode": "area",
1544 |         "justifyMode": "auto",
1545 |         "orientation": "auto",
1546 |         "reduceOptions": {
1547 |           "calcs": [
1548 |             "last"
1549 |           ],
1550 |           "fields": "",
1551 |           "values": false
1552 |         },
1553 |         "textMode": "auto"
1554 |       },
1555 |       "pluginVersion": "7.3.7",
1556 |       "targets": [
1557 |         {
1558 |           "expr": "sum(apisix_etcd_reachable{instance=~\"$instance\"})",
1559 |           "interval": "",
1560 |           "legendFormat": "",
1561 |           "refId": "A"
1562 |         }
1563 |       ],
1564 |       "timeFrom": null,
1565 |       "timeShift": null,
1566 |       "title": "Etcd reachable",
1567 |       "type": "stat"
1568 |     },
1569 |     {
1570 |       "datasource": "${DS_PROMETHEUS}",
1571 |       "fieldConfig": {
1572 |         "defaults": {
1573 |           "custom": {},
1574 |           "mappings": [],
1575 |           "thresholds": {
1576 |             "mode": "absolute",
1577 |             "steps": [
1578 |               {
1579 |                 "color": "green",
1580 |                 "value": null
1581 |               },
1582 |               {
1583 |                 "color": "yellow",
1584 |                 "value": 1
1585 |               }
1586 |             ]
1587 |           }
1588 |         },
1589 |         "overrides": []
1590 |       },
1591 |       "gridPos": {
1592 |         "h": 6,
1593 |         "w": 3,
1594 |         "x": 21,
1595 |         "y": 51
1596 |       },
1597 |       "id": 29,
1598 |       "options": {
1599 |         "colorMode": "value",
1600 |         "graphMode": "area",
1601 |         "justifyMode": "auto",
1602 |         "orientation": "auto",
1603 |         "reduceOptions": {
1604 |           "calcs": [
1605 |             "last"
1606 |           ],
1607 |           "fields": "",
1608 |           "values": false
1609 |         },
1610 |         "textMode": "auto"
1611 |       },
1612 |       "pluginVersion": "7.3.7",
1613 |       "targets": [
1614 |         {
1615 |           "expr": "sum(apisix_nginx_metric_errors_total{instance=~\"$instance\"})",
1616 |           "interval": "",
1617 |           "legendFormat": "",
1618 |           "refId": "A"
1619 |         }
1620 |       ],
1621 |       "timeFrom": null,
1622 |       "timeShift": null,
1623 |       "title": "Nginx metric errors",
1624 |       "type": "stat"
1625 |     }
1626 |   ],
1627 |   "refresh": "5s",
1628 |   "schemaVersion": 26,
1629 |   "style": "dark",
1630 |   "tags": [],
1631 |   "templating": {
1632 |     "list": [
1633 |        {
1634 |         "hide": 0,
1635 |         "label": "datasource",
1636 |         "name": "DS_PROMETHEUS",
1637 |         "options": [],
1638 |         "query": "prometheus",
1639 |         "refresh": 1,
1640 |         "regex": "apisix",
1641 |         "type": "datasource"
1642 |       },
1643 |       {
1644 |         "allValue": ".*",
1645 |         "current": {},
1646 |         "datasource": "${DS_PROMETHEUS}",
1647 |         "definition": "label_values(apisix_http_status,service)",
1648 |         "error": null,
1649 |         "hide": 0,
1650 |         "includeAll": true,
1651 |         "label": null,
1652 |         "multi": true,
1653 |         "name": "service",
1654 |         "options": [],
1655 |         "query": "label_values(apisix_http_status,service)",
1656 |         "refresh": 2,
1657 |         "regex": "",
1658 |         "skipUrlSync": false,
1659 |         "sort": 1,
1660 |         "tagValuesQuery": "",
1661 |         "tags": [],
1662 |         "tagsQuery": "",
1663 |         "type": "query",
1664 |         "useTags": false
1665 |       },
1666 |       {
1667 |         "allValue": ".*",
1668 |         "current": {},
1669 |         "datasource": "${DS_PROMETHEUS}",
1670 |         "definition": "label_values(apisix_http_status,route)",
1671 |         "error": null,
1672 |         "hide": 0,
1673 |         "includeAll": true,
1674 |         "label": null,
1675 |         "multi": true,
1676 |         "name": "route",
1677 |         "options": [],
1678 |         "query": "label_values(apisix_http_status,route)",
1679 |         "refresh": 2,
1680 |         "regex": "",
1681 |         "skipUrlSync": false,
1682 |         "sort": 1,
1683 |         "tagValuesQuery": "",
1684 |         "tags": [],
1685 |         "tagsQuery": "",
1686 |         "type": "query",
1687 |         "useTags": false
1688 |       },
1689 |       {
1690 |         "allValue": ".*",
1691 |         "current": {},
1692 |         "datasource": "${DS_PROMETHEUS}",
1693 |         "definition": "label_values(apisix_nginx_http_current_connections,instance)",
1694 |         "error": null,
1695 |         "hide": 0,
1696 |         "includeAll": true,
1697 |         "label": null,
1698 |         "multi": true,
1699 |         "name": "instance",
1700 |         "options": [],
1701 |         "query": "label_values(apisix_http_status,instance)",
1702 |         "refresh": 2,
1703 |         "regex": ".*",
1704 |         "skipUrlSync": false,
1705 |         "sort": 1,
1706 |         "tagValuesQuery": "",
1707 |         "tags": [],
1708 |         "tagsQuery": "",
1709 |         "type": "query",
1710 |         "useTags": false
1711 |       },
1712 |       {
1713 |         "allValue": ".*",
1714 |         "current": {},
1715 |         "datasource": "${DS_PROMETHEUS}",
1716 |         "definition": "label_values(apisix_http_status,consumer)",
1717 |         "error": null,
1718 |         "hide": 0,
1719 |         "includeAll": true,
1720 |         "label": null,
1721 |         "multi": true,
1722 |         "name": "consumer",
1723 |         "options": [],
1724 |         "query": "label_values(apisix_http_status,consumer)",
1725 |         "refresh": 2,
1726 |         "regex": ".*",
1727 |         "skipUrlSync": false,
1728 |         "sort": 1,
1729 |         "tagValuesQuery": "",
1730 |         "tags": [],
1731 |         "tagsQuery": "",
1732 |         "type": "query",
1733 |         "useTags": false
1734 |       },
1735 |       {
1736 |         "allValue": ".*",
1737 |         "current": {},
1738 |         "datasource": "${DS_PROMETHEUS}",
1739 |         "definition": "label_values(apisix_http_status,node)",
1740 |         "error": null,
1741 |         "hide": 0,
1742 |         "includeAll": true,
1743 |         "label": null,
1744 |         "multi": true,
1745 |         "name": "node",
1746 |         "options": [],
1747 |         "query": "label_values(apisix_http_status,node)",
1748 |         "refresh": 2,
1749 |         "regex": "",
1750 |         "skipUrlSync": false,
1751 |         "sort": 1,
1752 |         "tagValuesQuery": "",
1753 |         "tags": [],
1754 |         "tagsQuery": "",
1755 |         "type": "query",
1756 |         "useTags": false
1757 |       }
1758 |     ]
1759 |   },
1760 |   "time": {
1761 |     "from": "now-30m",
1762 |     "to": "now"
1763 |   },
1764 |   "timepicker": {
1765 |     "refresh_intervals": [
1766 |       "5s",
1767 |       "10s",
1768 |       "30s",
1769 |       "1m",
1770 |       "5m",
1771 |       "15m",
1772 |       "30m",
1773 |       "1h",
1774 |       "2h",
1775 |       "1d"
1776 |     ]
1777 |   },
1778 |   "timezone": "",
1779 |   "title": "Apache APISIX",
1780 |   "uid": "bLlNuRLWz",
1781 |   "version": 13
1782 | }


--------------------------------------------------------------------------------
/grafana_conf/provisioning/dashboards/all.yaml:
--------------------------------------------------------------------------------
 1 | #
 2 | # Licensed to the Apache Software Foundation (ASF) under one or more
 3 | # contributor license agreements.  See the NOTICE file distributed with
 4 | # this work for additional information regarding copyright ownership.
 5 | # The ASF licenses this file to You under the Apache License, Version 2.0
 6 | # (the "License"); you may not use this file except in compliance with
 7 | # the License.  You may obtain a copy of the License at
 8 | #
 9 | #     http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 | apiVersion: 1
18 | 
19 | providers:
20 | - name: 'default'
21 |   orgId: 1
22 |   folder: ''
23 |   type: file
24 |   disableDeletion: false
25 |   editable: false
26 |   options:
27 |     path: /var/lib/grafana/dashboards
28 | 


--------------------------------------------------------------------------------
/grafana_conf/provisioning/datasources/all.yaml:
--------------------------------------------------------------------------------
 1 | #
 2 | # Licensed to the Apache Software Foundation (ASF) under one or more
 3 | # contributor license agreements.  See the NOTICE file distributed with
 4 | # this work for additional information regarding copyright ownership.
 5 | # The ASF licenses this file to You under the Apache License, Version 2.0
 6 | # (the "License"); you may not use this file except in compliance with
 7 | # the License.  You may obtain a copy of the License at
 8 | #
 9 | #     http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 | datasources:
18 |  - access: 'proxy'
19 |    editable: true
20 |    is_default: true
21 |    name: 'apisix'
22 |    org_id: 1
23 |    type: 'prometheus'
24 |    url: 'http://prometheus:9090'
25 |    version: 1
26 | 


--------------------------------------------------------------------------------
/prometheus_conf/prometheus.yml:
--------------------------------------------------------------------------------
 1 | #
 2 | # Licensed to the Apache Software Foundation (ASF) under one or more
 3 | # contributor license agreements.  See the NOTICE file distributed with
 4 | # this work for additional information regarding copyright ownership.
 5 | # The ASF licenses this file to You under the Apache License, Version 2.0
 6 | # (the "License"); you may not use this file except in compliance with
 7 | # the License.  You may obtain a copy of the License at
 8 | #
 9 | #     http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 | 
18 | global:
19 |   scrape_interval: 1s     # By default, scrape targets every 15 seconds.
20 | 
21 |   # Attach these labels to any time series or alerts when communicating with
22 |   # external systems (federation, remote storage, Alertmanager).
23 |   external_labels:
24 |     stack: "apisix"
25 | 
26 | 
27 | # A scrape configuration containing exactly one endpoint to scrape:
28 | # Here it's Prometheus itself.
29 | scrape_configs:
30 |   # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
31 |   - job_name: "prometheus"
32 |     # Override the global default and scrape targets from this job every 5 seconds.
33 |     scrape_interval: 5s
34 |     static_configs:
35 |       - targets: ["localhost:9090"]
36 |   - job_name: "apisix"
37 |     scrape_interval: 5s
38 |     metrics_path: "/apisix/prometheus/metrics"
39 |     static_configs:
40 |       - targets: ["host.docker.internal:9091"]
41 | 


--------------------------------------------------------------------------------