You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by yi...@apache.org on 2023/01/20 06:32:09 UTC

[skywalking-python] branch master updated: Add tables to show agent features and clean up configs (#271)

This is an automated email from the ASF dual-hosted git repository.

yihaochen pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking-python.git


The following commit(s) were added to refs/heads/master by this push:
     new 59bf030  Add tables to show agent features and clean up configs (#271)
59bf030 is described below

commit 59bf030043f211ceb03733d6e35b679ea7ad93b5
Author: Superskyyy <Su...@outlook.com>
AuthorDate: Fri Jan 20 01:32:02 2023 -0500

    Add tables to show agent features and clean up configs (#271)
    
    * Clean up docs to show our features
---
 CHANGELOG.md                      |   1 +
 README.md                         |  17 ++++--
 docs/README.md                    |  23 ++++++---
 docs/en/setup/EnvVars.md          | 106 ++++++++++++++++++++------------------
 docs/en/setup/Installation.md     |  30 +++++++++--
 docs/menu.yml                     |   4 +-
 skywalking/config.py              |  43 +++++++++-------
 skywalking/meter/meter_service.py |   4 +-
 8 files changed, 141 insertions(+), 87 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 380eac4..8549a06 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -34,6 +34,7 @@
   - New documentation on the newly added meter reporter feature (#240)
   - New documentation on the newly added greenlet profiler and the original threading profiler (#250)
   - Overhaul documentation on development setup and testing (#249)
+  - Add tables to state currently supported features of Python agent. (#271)
 
 - Others:
   - Pin CI SkyWalking License Eye (#221)
diff --git a/README.md b/README.md
index c1cf219..bb79658 100755
--- a/README.md
+++ b/README.md
@@ -19,6 +19,16 @@
 - [Official documentation](https://skywalking.apache.org/docs/#PythonAgent)
 - [Blog](https://skywalking.apache.org/blog/2021-09-12-skywalking-python-profiling/) about the Python Agent Profiling Feature
 
+## Capabilities
+
+| Reporter  | Supported?       | Details                                                    | 
+|:----------|:-----------------|:-----------------------------------------------------------|
+| Trace     | ✅ (default: ON)  | Automatic instrumentation + Manual SDK                     |            
+| Log       | ✅ (default: OFF) | Direct reporter only. (Tracing context in log planned)     |
+| Meter     | ✅ (default: ON)  | Meter API + Automatic PVM metrics                          |
+| Event     | ❌ (Planned)      | Report lifecycle events of your awesome Python application |
+| Profiling | ✅ (default: ON)  | Threading and Greenlet Profiler                            |
+
 ## Installation Requirements
 
 SkyWalking Python Agent requires [Apache SkyWalking 8.0+](https://skywalking.apache.org/downloads/#SkyWalkingAPM) and Python 3.7+.
@@ -26,7 +36,7 @@ SkyWalking Python Agent requires [Apache SkyWalking 8.0+](https://skywalking.apa
 > If you would like to try out the latest features that are not released yet, please refer to this [guide](docs/en/setup/faq/How-to-build-from-sources.md) to build from sources.
 
 ## Live Demo
-- Find the [live demo](https://skywalking.apache.org/#demo) and [screenshots](https://skywalking.apache.org/#arch) on our website.
+- Find the [live demo](https://skywalking.apache.org/#demo) with Python agent on our website.
 - Follow the [showcase](https://skywalking.apache.org/docs/skywalking-showcase/next/readme/) to set up preview deployment quickly.
 
 ## Contributing
@@ -34,10 +44,11 @@ SkyWalking Python Agent requires [Apache SkyWalking 8.0+](https://skywalking.apa
 Before submitting a pull request or pushing a commit, please read our [contributing](CONTRIBUTING.md) and [developer guide](docs/en/contribution/Developer.md).
 
 ## Contact Us
-* Submit an [GitHub Issue](https://github.com/apache/skywalking/issues/new) by using [Python] as title prefix.
 * Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.
-* Join `skywalking` channel at [Apache Slack](http://s.apache.org/slack-invite). If the link is not working, find the latest one at [Apache INFRA WIKI](https://cwiki.apache.org/confluence/display/INFRA/Slack+Guest+Invites).
+* Send `Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in.
 * Twitter, [ASFSkyWalking](https://twitter.com/AsfSkyWalking)
+* QQ Group: 901167865, 392443393
+* [bilibili B站 视频](https://space.bilibili.com/390683219)
 
 ## License
 Apache 2.0
diff --git a/docs/README.md b/docs/README.md
index a251d0e..d43f8ef 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -13,14 +13,21 @@ This documentation covers a number of ways to set up the Python agent for variou
 ![Version](https://img.shields.io/pypi/pyversions/apache-skywalking)
 ![Build](https://github.com/apache/skywalking-python/actions/workflows/CI.yaml/badge.svg?event=push)
 
-## Contact Us
+## Capabilities
 
-* Submit an [issue](https://github.com/apache/skywalking/issues/new) following the GitHub Issues template.
-* Mail list: **dev@skywalking.apache.org**. 
-Mail to **dev-subscribe@skywalking.apache.org**, follow the reply to subscribe the mail list.
-* Join the `skywalking` Slack channel at Apache Software Foundation by sending a request to the mail list - dev@skywalking.apache.org, we will invite you in.
-* Twitter - [ASFSkyWalking](https://twitter.com/AsfSkyWalking)
+The following table demonstrates the currently supported telemetry collection capabilities in SkyWalking Python agent:
 
-## Contributing
+| Reporter  | Supported?       | Details                                                    | 
+|:----------|:-----------------|:-----------------------------------------------------------|
+| Trace     | ✅ (default: ON)  | Automatic instrumentation + Manual SDK                     |            
+| Log       | ✅ (default: OFF) | Direct reporter only. (Tracing context in log planned)     |
+| Meter     | ✅ (default: ON)  | Meter API + Automatic PVM metrics                          |
+| Event     | ❌ (Planned)      | Report lifecycle events of your awesome Python application |
+| Profiling | ✅ (default: ON)  | Threading and Greenlet Profiler                            |
 
-Before submitting a pull request or push a commit, please read our [contributing](https://github.com/apache/skywalking-python/blob/master/CONTRIBUTING.md) and [developer guide](en/contribution/Developer.md).
+
+## Live Demo
+
+- Find the [live demo](https://skywalking.apache.org/#demo) with Python agent on our website.
+- Follow the [showcase](https://skywalking.apache.org/docs/skywalking-showcase/next/readme/) to set up preview
+  deployment quickly.
diff --git a/docs/en/setup/EnvVars.md b/docs/en/setup/EnvVars.md
index 2735713..9351646 100644
--- a/docs/en/setup/EnvVars.md
+++ b/docs/en/setup/EnvVars.md
@@ -1,53 +1,61 @@
 # Supported Environment Variables
 
-Below is the full list of supported environment variables you can set to 
+Below is the full list of supported environment variables you can set to
 customize the agent behavior, please read the descriptions for what they can achieve.
 
- | Environment Variable                                | Description                                                                                                                                                                                                                                                                                             | Default|
-|:----------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| :--- |
-| `SW_AGENT_NAME`                                     | The name of the Python service                                                                                                                                                                                                                                                                          | `Python Service Name` |
-| `SW_AGENT_INSTANCE`                                 | The name of the Python service instance                                                                                                                                                                                                                                                                 | Randomly generated |
-| `SW_AGENT_NAMESPACE`                                | The agent namespace of the Python service                                                                                                                                                                                                                                                               | unset |
-| `SW_AGENT_COLLECTOR_BACKEND_SERVICES`               | The backend OAP server address                                                                                                                                                                                                                                                                          | `127.0.0.1:11800` |
-| `SW_AGENT_FORCE_TLS`                                | Use TLS for communication with server (no cert required)                                                                                                                                                                                                                                                | `False` |
-| `SW_AGENT_PROTOCOL`                                 | The protocol to communicate with the backend OAP, `http`, `grpc` or `kafka`, **we highly suggest using `grpc` in production as it's well optimized than `http`**. The `kafka` protocol provides an alternative way to submit data to the backend.                                                       | `grpc` |
-| `SW_AGENT_AUTHENTICATION`                           | The authentication token to verify that the agent is trusted by the backend OAP, as for how to configure the backend, refer to [the yaml](https://github.com/apache/skywalking/blob/4f0f39ffccdc9b41049903cc540b8904f7c9728e/oap-server/server-bootstrap/src/main/resources/application.yml#L155-L158). | unset |
-| `SW_AGENT_LOGGING_LEVEL`                            | The logging level, could be one of `CRITICAL`, `FATAL`, `ERROR`, `WARN`(`WARNING`), `INFO`, `DEBUG`                                                                                                                                                                                                     | `INFO` |
-| `SW_AGENT_DISABLE_PLUGINS`                          | The name patterns in CSV pattern, plugins whose name matches one of the pattern won't be installed                                                                                                                                                                                                      | `''` |
-| `SW_AGENT_MAX_BUFFER_SIZE`                          | The maximum queue backlog size for sending the segment data to backend, segments beyond this are silently dropped                                                                                                                                                                                       | `'10000'` |
-| `SW_HTTP_IGNORE_METHOD`                             | Comma-delimited list of http methods to ignore (GET, POST, HEAD, OPTIONS, etc...)                                                                                                                                                                                                                       | `` |
-| `SW_SQL_PARAMETERS_LENGTH`                          | The maximum length of the collected parameter, parameters longer than the specified length will be truncated, length 0 turns off parameter tracing                                                                                                                                                      | `0` |
-| `SW_PYMONGO_TRACE_PARAMETERS`                       | Indicates whether to collect the filters of pymongo                                                                                                                                                                                                                                                     | `False` |
-| `SW_PYMONGO_PARAMETERS_MAX_LENGTH`                  | The maximum length of the collected filters, filters longer than the specified length will be truncated                                                                                                                                                                                                 |  `512` |
-| `SW_IGNORE_SUFFIX`                                  | If the operation name of the first span is included in this set, this segment should be ignored.                                                                                                                                                                                                        | `.jpg,.jpeg,.js,.css,.png,.bmp,.gif,.ico,.mp3,.mp4,.html,.svg` |
-| `SW_FLASK_COLLECT_HTTP_PARAMS`                      | This config item controls that whether the Flask plugin should collect the parameters of the request.                                                                                                                                                                                                   | `false` |
-| `SW_DJANGO_COLLECT_HTTP_PARAMS`                     | This config item controls that whether the Django plugin should collect the parameters of the request.                                                                                                                                                                                                  | `false` |
-| `SW_HTTP_PARAMS_LENGTH_THRESHOLD`                   | When `COLLECT_HTTP_PARAMS` is enabled, how many characters to keep and send to the OAP backend, use negative values to keep and send the complete parameters, NB. this config item is added for the sake of performance.                                                                                | `1024` |
-| `SW_CORRELATION_ELEMENT_MAX_NUMBER`                 | Max element count of the correlation context.                                                                                                                                                                                                                                                           | `3` |
-| `SW_CORRELATION_VALUE_MAX_LENGTH`                   | Max value length of correlation context element.                                                                                                                                                                                                                                                        | `128` |
-| `SW_TRACE_IGNORE`                                   | This config item controls that whether the trace should be ignore                                                                                                                                                                                                                                       | `false` |
-| `SW_TRACE_IGNORE_PATH`                              | You can setup multiple URL path patterns, The endpoints match these patterns wouldn't be traced. the current matching rules follow Ant Path match style , like /path/*, /path/**, /path/?.                                                                                                              | `''` |
-| `SW_ELASTICSEARCH_TRACE_DSL`                        | If true, trace all the DSL(Domain Specific Language) in ElasticSearch access, default is false                                                                                                                                                                                                          | `false` |
-| `SW_KAFKA_REPORTER_BOOTSTRAP_SERVERS`               | A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. It is in the form host1:port1,host2:port2,...                                                                                                                                                            | `localhost:9092` |
-| `SW_KAFKA_REPORTER_TOPIC_MANAGEMENT`                | Specifying Kafka topic name for service instance reporting and registering.                                                                                                                                                                                                                             | `skywalking-managements` |
-| `SW_KAFKA_REPORTER_TOPIC_SEGMENT`                   | Specifying Kafka topic name for Tracing data.                                                                                                                                                                                                                                                           | `skywalking-segments` |
-| `SW_KAFKA_REPORTER_TOPIC_LOG`                       | Specifying Kafka topic name for Log data.                                                                                                                                                                                                                                                               | `skywalking-logs` |
-| `SW_KAFKA_REPORTER_CONFIG_key`                      | The configs to init KafkaProducer. it support the basic arguments (whose type is either `str`, `bool`, or `int`) listed [here](https://kafka-python.readthedocs.io/en/master/apidoc/KafkaProducer.html#kafka.KafkaProducer)                                                                             | unset |
-| `SW_CELERY_PARAMETERS_LENGTH`                       | The maximum length of `celery` functions parameters, longer than this will be truncated, 0 turns off                                                                                                                                                                                                    | `512` |
-| `SW_AGENT_PROFILE_ACTIVE`                           | If `True`, Python agent will enable profile when user create a new profile task. Otherwise disable profile.                                                                                                                                                                                             | `True` |
-| `SW_PROFILE_TASK_QUERY_INTERVAL`                    | The number of seconds between two profile task query.                                                                                                                                                                                                                                                   | `20` |
-| `SW_AGENT_PROFILE_MAX_PARALLEL`                     | The number of parallel monitor segment count.                                                                                                                                                                                                                                                           | `5` |
-| `SW_AGENT_PROFILE_DURATION`                         | The maximum monitor segment time(minutes), if current segment monitor time out of limit, then stop it.                                                                                                                                                                                                  | `10` |
-| `SW_AGENT_PROFILE_DUMP_MAX_STACK_DEPTH`             | The number of max dump thread stack depth                                                                                                                                                                                                                                                               | `500` |
-| `SW_AGENT_PROFILE_SNAPSHOT_TRANSPORT_BUFFER_SIZE`   | The number of snapshot transport to backend buffer size                                                                                                                                                                                                                                                 | `50` |
-| `SW_AGENT_LOG_REPORTER_ACTIVE`                      | If `True`, Python agent will report collected logs to the OAP or Satellite. Otherwise, it disables the feature.                                                                                                                                                                                         | `False` |
-| `SW_AGENT_LOG_REPORTER_SAFE_MODE`                   | If `True`, Python agent will filter out HTTP basic auth information from log records. Otherwise, it disables the feature due to potential performance impact brought by regular expression                                                                                                              | `False` |
-| `SW_AGENT_LOG_REPORTER_BUFFER_SIZE`                 | The maximum queue backlog size for sending log data to backend, logs beyond this are silently dropped.                                                                                                                                                                                                  | `10000` |
-| `SW_AGENT_LOG_REPORTER_LEVEL`                       | This config specifies the logger levels of concern, any logs with a level below the config will be ignored.                                                                                                                                                                                             | `WARNING` |
-| `SW_AGENT_LOG_REPORTER_IGNORE_FILTER`               | This config customizes whether to ignore the application-defined logger filters, if `True`, all logs are reported disregarding any filter rules.                                                                                                                                                        | `False` |
-| `SW_AGENT_LOG_REPORTER_FORMATTED`                   | If `True`, the log reporter will transmit the logs as formatted. Otherwise, puts logRecord.msg and logRecord.args into message content and tags(`argument.n`), respectively. Along with an `exception` tag if an exception was raised.                                                                  | `True` |
-| `SW_AGENT_LOG_REPORTER_LAYOUT`                      | The log reporter formats the logRecord message based on the layout given.                                                                                                                                                                                                                               | `%(asctime)s [%(threadName)s] %(levelname)s %(name)s - %(message)s` |
-| `SW_AGENT_CAUSE_EXCEPTION_DEPTH`                    | This config limits agent to report up to `limit` stacktrace, please refer to [Python traceback](https://docs.python.org/3/library/traceback.html#traceback.print_tb) for more explanations.                                                                                                             | `10` | 
-| `SW_PYTHON_BOOTSTRAP_PROPAGATE`                     | This config controls the child process agent bootstrap behavior in `sw-python` CLI, if set to `False`, a valid child process will not boot up a SkyWalking Agent. Please refer to the [CLI Guide](CLI.md) for details.                                                                                  | unset |
-| `SW_FASTAPI_COLLECT_HTTP_PARAMS`                    | This config item controls that whether the FastAPI plugin should collect the parameters of the request.                                                                                                                                                                                                 | `false` |
-| `SW_BOTTLE_COLLECT_HTTP_PARAMS`                    | This config item controls that whether the Bottle plugin should collect the parameters of the request.                                                                                                                                                                                                 | `false` |
+| Core Level Environment Variables                  | Description                                                                                                                                                                                                                                                                                             | Default                                                             |
+|:--------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------|
+| `SW_AGENT_NAME`                                   | The name of the Python service                                                                                                                                                                                                                                                                          | `Python Service Name`                                               |
+| `SW_AGENT_INSTANCE`                               | The name of the Python service instance                                                                                                                                                                                                                                                                 | Randomly generated                                                  |
+| `SW_AGENT_NAMESPACE`                              | The agent namespace of the Python service                                                                                                                                                                                                                                                               | unset                                                               |
+| `SW_AGENT_COLLECTOR_BACKEND_SERVICES`             | The backend OAP server address                                                                                                                                                                                                                                                                          | `127.0.0.1:11800`                                                   |
+| `SW_KAFKA_REPORTER_BOOTSTRAP_SERVERS`             | A list of host/port pairs to use for establishing the initial connection to the Kafka cluster. It is in the form host1:port1,host2:port2,...                                                                                                                                                            | `localhost:9092`                                                    |
+| `SW_KAFKA_REPORTER_TOPIC_MANAGEMENT`              | Specifying Kafka topic name for service instance reporting and registering.                                                                                                                                                                                                                             | `skywalking-managements`                                            |
+| `SW_KAFKA_REPORTER_TOPIC_SEGMENT`                 | Specifying Kafka topic name for Tracing data.                                                                                                                                                                                                                                                           | `skywalking-segments`                                               |
+| `SW_KAFKA_REPORTER_TOPIC_LOG`                     | Specifying Kafka topic name for Log data.                                                                                                                                                                                                                                                               | `skywalking-logs`                                                   |
+| `SW_KAFKA_REPORTER_TOPIC_METER`                   | Specifying Kafka topic name for Meter data.                                                                                                                                                                                                                                                             | `skywalking-meters`                                                 |
+| `SW_AGENT_FORCE_TLS`                              | Use TLS for communication with server (no cert required)                                                                                                                                                                                                                                                | `False`                                                             |
+| `SW_AGENT_PROTOCOL`                               | The protocol to communicate with the backend OAP, `http`, `grpc` or `kafka`, **we highly suggest using `grpc` in production as it's well optimized than `http`**. The `kafka` protocol provides an alternative way to submit data to the backend.                                                       | `grpc`                                                              |
+| `SW_AGENT_AUTHENTICATION`                         | The authentication token to verify that the agent is trusted by the backend OAP, as for how to configure the backend, refer to [the yaml](https://github.com/apache/skywalking/blob/4f0f39ffccdc9b41049903cc540b8904f7c9728e/oap-server/server-bootstrap/src/main/resources/application.yml#L155-L158). | unset                                                               |
+| `SW_AGENT_LOGGING_LEVEL`                          | The logging level, could be one of `CRITICAL`, `FATAL`, `ERROR`, `WARN`(`WARNING`), `INFO`, `DEBUG`                                                                                                                                                                                                     | `INFO`                                                              |
+| `SW_AGENT_DISABLE_PLUGINS`                        | The name patterns in CSV pattern, plugins whose name matches one of the pattern won't be installed                                                                                                                                                                                                      | `''`                                                                |
+| `SW_AGENT_MAX_BUFFER_SIZE`                        | The maximum queue backlog size for sending the segment data to backend, segments beyond this are silently dropped                                                                                                                                                                                       | `'10000'`                                                           |
+| `SW_TRACE_IGNORE_PATH`                            | You can setup multiple URL path patterns, The endpoints match these patterns wouldn't be traced. the current matching rules follow Ant Path match style , like /path/*, /path/**, /path/?.                                                                                                              | `''`                                                                |
+| `SW_IGNORE_SUFFIX`                                | If the operation name of the first span is included in this set, this segment should be ignored.                                                                                                                                                                                                        | `.jpg,.jpeg,.js,.css,.png,.bmp,.gif,.ico,.mp3,.mp4,.html,.svg`      |
+| `SW_CORRELATION_ELEMENT_MAX_NUMBER`               | Max element count of the correlation context.                                                                                                                                                                                                                                                           | `3`                                                                 |
+| `SW_CORRELATION_VALUE_MAX_LENGTH`                 | Max value length of correlation context element.                                                                                                                                                                                                                                                        | `128`                                                               |
+| `SW_PYTHON_BOOTSTRAP_PROPAGATE`                   | Special: can only be passed via environment. This config controls the child process agent bootstrap behavior in `sw-python` CLI, if set to `False`, a valid child process will not boot up a SkyWalking Agent. Please refer to the [CLI Guide](CLI.md) for details.                                     | unset                                                               |
+| `SW_AGENT_PROFILE_ACTIVE`                         | If `True`, Python agent will enable profile when user create a new profile task. Otherwise disable profile.                                                                                                                                                                                             | `True`                                                              |
+| `SW_PROFILE_TASK_QUERY_INTERVAL`                  | The number of seconds between two profile task query.                                                                                                                                                                                                                                                   | `20`                                                                |
+| `SW_AGENT_PROFILE_MAX_PARALLEL`                   | The number of parallel monitor segment count.                                                                                                                                                                                                                                                           | `5`                                                                 |
+| `SW_AGENT_PROFILE_DURATION`                       | The maximum monitor segment time(minutes), if current segment monitor time out of limit, then stop it.                                                                                                                                                                                                  | `10`                                                                |
+| `SW_AGENT_PROFILE_DUMP_MAX_STACK_DEPTH`           | The number of max dump thread stack depth                                                                                                                                                                                                                                                               | `500`                                                               |
+| `SW_AGENT_PROFILE_SNAPSHOT_TRANSPORT_BUFFER_SIZE` | The number of snapshot transport to backend buffer size                                                                                                                                                                                                                                                 | `50`                                                                |
+| `SW_AGENT_LOG_REPORTER_ACTIVE`                    | If `True`, Python agent will report collected logs to the OAP or Satellite. Otherwise, it disables the feature.                                                                                                                                                                                         | `True`                                                              |
+| `SW_AGENT_LOG_REPORTER_SAFE_MODE`                 | If `True`, Python agent will filter out HTTP basic auth information from log records. Otherwise, it disables the feature due to potential performance impact brought by regular expression                                                                                                              | `False`                                                             |
+| `SW_AGENT_LOG_REPORTER_BUFFER_SIZE`               | The maximum queue backlog size for sending log data to backend, logs beyond this are silently dropped.                                                                                                                                                                                                  | `10000`                                                             |
+| `SW_AGENT_LOG_REPORTER_LEVEL`                     | This config specifies the logger levels of concern, any logs with a level below the config will be ignored.                                                                                                                                                                                             | `WARNING`                                                           |
+| `SW_AGENT_LOG_REPORTER_IGNORE_FILTER`             | This config customizes whether to ignore the application-defined logger filters, if `True`, all logs are reported disregarding any filter rules.                                                                                                                                                        | `False`                                                             |
+| `SW_AGENT_LOG_REPORTER_FORMATTED`                 | If `True`, the log reporter will transmit the logs as formatted. Otherwise, puts logRecord.msg and logRecord.args into message content and tags(`argument.n`), respectively. Along with an `exception` tag if an exception was raised.                                                                  | `True`                                                              |
+| `SW_AGENT_LOG_REPORTER_LAYOUT`                    | The log reporter formats the logRecord message based on the layout given.                                                                                                                                                                                                                               | `%(asctime)s [%(threadName)s] %(levelname)s %(name)s - %(message)s` |
+| `SW_AGENT_CAUSE_EXCEPTION_DEPTH`                  | This config limits agent to report up to `limit` stacktrace, please refer to [Python traceback](https://docs.python.org/3/library/traceback.html#traceback.print_tb) for more explanations.                                                                                                             | `10`                                                                | 
+| `SW_AGENT_METER_REPORTER_ACTIVE`                  | If `True`, Python agent will report collected meters to the OAP or Satellite. Otherwise, it disables the feature.                                                                                                                                                                                       | `True`                                                              | 
+| `SW_AGENT_METER_REPORTER_BUFFER_SIZE`             | The maximum queue backlog size for sending meter data to backend, meters beyond this are silently dropped.                                                                                                                                                                                              | `10000`                                                             | 
+| `SW_AGENT_METER_REPORTER_PEROID`                  | The interval in seconds between each meter data report                                                                                                                                                                                                                                                  | `20`                                                                | 
+| `SW_AGENT_PVM_METER_REPORTER_ACTIVE`              | If `True`, Python agent will report collected Python Virtual Machine (PVM) meters to the OAP or Satellite. Otherwise, it disables the feature.                                                                                                                                                          | `True`                                                              | 
+
+| Plugin Level Environment Variables | Description                                                                                                                                                                                                              | Default |
+|:-----------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
+| `SW_SQL_PARAMETERS_LENGTH`         | The maximum length of the collected parameter, parameters longer than the specified length will be truncated, length 0 turns off parameter tracing                                                                       | `0`     |
+| `SW_PYMONGO_TRACE_PARAMETERS`      | Indicates whether to collect the filters of pymongo                                                                                                                                                                      | `False` |
+| `SW_PYMONGO_PARAMETERS_MAX_LENGTH` | The maximum length of the collected filters, filters longer than the specified length will be truncated                                                                                                                  | `512`   |
+| `SW_ELASTICSEARCH_TRACE_DSL`       | If true, trace all the DSL(Domain Specific Language) in ElasticSearch access, default is false                                                                                                                           | `false` |
+| `SW_HTTP_PARAMS_LENGTH_THRESHOLD`  | When `COLLECT_HTTP_PARAMS` is enabled, how many characters to keep and send to the OAP backend, use negative values to keep and send the complete parameters, NB. this config item is added for the sake of performance. | `1024`  |
+| `SW_HTTP_IGNORE_METHOD`            | Comma-delimited list of http methods to ignore (GET, POST, HEAD, OPTIONS, etc...)                                                                                                                                        | ``      |
+| `SW_FLASK_COLLECT_HTTP_PARAMS`     | This config item controls that whether the Flask plugin should collect the parameters of the request.                                                                                                                    | `false` |
+| `SW_SANIC_COLLECT_HTTP_PARAMS`     | This config item controls that whether the Sanic plugin should collect the parameters of the request.                                                                                                                    | `false` |
+| `SW_DJANGO_COLLECT_HTTP_PARAMS`    | This config item controls that whether the Django plugin should collect the parameters of the request.                                                                                                                   | `false` |
+| `SW_FASTAPI_COLLECT_HTTP_PARAMS`   | This config item controls that whether the FastAPI plugin should collect the parameters of the request.                                                                                                                  | `false` |
+| `SW_BOTTLE_COLLECT_HTTP_PARAMS`    | This config item controls that whether the Bottle plugin should collect the parameters of the request.                                                                                                                   | `false` |
+| `SW_CELERY_PARAMETERS_LENGTH`      | The maximum length of `celery` functions parameters, longer than this will be truncated, 0 turns off                                                                                                                     | `512`   |
+
diff --git a/docs/en/setup/Installation.md b/docs/en/setup/Installation.md
index 293a78a..4b912f9 100644
--- a/docs/en/setup/Installation.md
+++ b/docs/en/setup/Installation.md
@@ -4,11 +4,27 @@
 
 You can install the SkyWalking Python agent via various ways.
 
-> If you want to try out the latest features that are not released yet, please refer to this [guide](faq/How-to-build-from-sources.md) to build from sources.
+> If you want to try out the latest features that are not released yet, please refer to
+> this [guide](faq/How-to-build-from-sources.md) to build from sources.
+
+## Important Note on Different Reporter Protocols
+
+Currently only gRPC protocol fully supports [all available telemetry capabilities](../../README.md#capabilities) in the Python agent.
+
+While gRPC is highly recommended, we provide alternative protocols to suit your production requirements.
+
+Please refer to the table below before deciding which report protocol suits best for you.
+
+| Reporter Protocol | Trace Reporter | Log Reporter | Meter Reporter | Profiling | 
+|:------------------|:---------------|:-------------|:---------------|:----------|
+| gRPC              | ✅              | ✅            | ✅              | ✅         |                
+| HTTP              | ✅              | ✅            | ❌              | ❌         |                 
+| Kafka             | ✅              | ✅            | ✅              | ❌         |     
 
 ### From PyPI
 
-The Python agent module is published to [PyPI](https://pypi.org/project/apache-skywalking/), from where you can use `pip` to install:
+The Python agent module is published to [PyPI](https://pypi.org/project/apache-skywalking/), 
+from where you can use `pip` to install:
 
 ```shell
 # Install the latest version, using the default gRPC protocol to report data to OAP
@@ -27,7 +43,7 @@ pip install apache-skywalking==0.1.0  # For example, install version 0.1.0 no ma
 
 ### From Docker Hub
 
-SkyWalking Python agent starts to provide convenient dockerfile 
+SkyWalking Python agent provides convenient dockerfile
 and images for easy integration utilizing its [auto-bootstrap](CLI.md) capability.
 
 Simply pull SkyWalking Python image from [Docker Hub](https://hub.docker.com/r/apache/skywalking-python)
@@ -36,11 +52,17 @@ based on desired agent version, protocol and Python version.
 ```dockerfile
 FROM apache/skywalking-python:0.8.0-grpc-py3.10
 
+# ... build your Python application
+
+# If you prefer compact images (built from official Python slim image)
+
+FROM apache/skywalking-python:0.8.0-grpc-py3.10-slim
+
 # ... build your Python application
 ```
 
 Then, You can build your Python application image based on our agent-enabled Python images and start
-your applications with SkyWalking agent enabled for you. Please refer to our 
+your applications with SkyWalking agent enabled for you. Please refer to our
 [Containerization Guide](Container.md) for further instructions on integration and configuring.
 
 ### From Source Code
diff --git a/docs/menu.yml b/docs/menu.yml
index 82d351f..b313b1e 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -34,7 +34,9 @@ catalog:
         catalog:
           - name: "Log Reporter"
             path: "/en/setup/advanced/LogReporter"
-          - name: "Manual Instrumentation"
+          - name: "Meter Reporter"
+            path: "/en/setup/advanced/MeterReporter"
+          - name: "Manual Trace Instrumentation"
             path: "/en/setup/advanced/API"
   - name: "Plugins"
     catalog:
diff --git a/skywalking/config.py b/skywalking/config.py
index 62da19b..d7e8b9c 100644
--- a/skywalking/config.py
+++ b/skywalking/config.py
@@ -50,32 +50,19 @@ ignore_suffix: str = os.getenv('SW_IGNORE_SUFFIX') or '.jpg,.jpeg,.js,.css,.png,
 correlation_element_max_number: int = int(os.getenv('SW_CORRELATION_ELEMENT_MAX_NUMBER') or '3')
 correlation_value_max_length: int = int(os.getenv('SW_CORRELATION_VALUE_MAX_LENGTH') or '128')
 
-# Plugin configurations
-sql_parameters_length: int = int(os.getenv('SW_SQL_PARAMETERS_LENGTH') or '0')
-pymongo_trace_parameters: bool = os.getenv('SW_PYMONGO_TRACE_PARAMETERS') == 'True'
-pymongo_parameters_max_length: int = int(os.getenv('SW_PYMONGO_PARAMETERS_MAX_LENGTH') or '512')
-elasticsearch_trace_dsl: bool = os.getenv('SW_ELASTICSEARCH_TRACE_DSL') == 'True'
-
-http_params_length_threshold: int = int(os.getenv('SW_HTTP_PARAMS_LENGTH_THRESHOLD') or '1024')
-http_ignore_method: str = os.getenv('SW_HTTP_IGNORE_METHOD', '').upper()
-flask_collect_http_params: bool = os.getenv('SW_FLASK_COLLECT_HTTP_PARAMS') == 'True'
-sanic_collect_http_params: bool = os.getenv('SW_SANIC_COLLECT_HTTP_PARAMS') == 'True'
-django_collect_http_params: bool = os.getenv('SW_DJANGO_COLLECT_HTTP_PARAMS') == 'True'
-fastapi_collect_http_params: bool = os.getenv('SW_FASTAPI_COLLECT_HTTP_PARAMS') == 'True'
-bottle_collect_http_params: bool = os.getenv('SW_BOTTLE_COLLECT_HTTP_PARAMS') == 'True'
-
-celery_parameters_length: int = int(os.getenv('SW_CELERY_PARAMETERS_LENGTH') or '512')
+# sw-python CLI
+# SW_PYTHON_BOOTSTRAP_PROPAGATE only available when passed as env var
 
 # profiling configurations
-get_profile_task_interval: int = int(os.getenv('SW_PROFILE_TASK_QUERY_INTERVAL') or '20')
 profile_active: bool = os.getenv('SW_AGENT_PROFILE_ACTIVE') != 'False'
+get_profile_task_interval: int = int(os.getenv('SW_PROFILE_TASK_QUERY_INTERVAL') or '20')
 profile_max_parallel: int = int(os.getenv('SW_AGENT_PROFILE_MAX_PARALLEL') or '5')
 profile_duration: int = int(os.getenv('SW_AGENT_PROFILE_DURATION') or '10')
 profile_dump_max_stack_depth: int = int(os.getenv('SW_AGENT_PROFILE_DUMP_MAX_STACK_DEPTH') or '500')
 profile_snapshot_transport_buffer_size: int = int(os.getenv('SW_AGENT_PROFILE_SNAPSHOT_TRANSPORT_BUFFER_SIZE') or '50')
 
 # log reporter configurations
-log_reporter_active: bool = os.getenv('SW_AGENT_LOG_REPORTER_ACTIVE') == 'True'
+log_reporter_active: bool = os.getenv('SW_AGENT_LOG_REPORTER_ACTIVE') != 'False'
 log_reporter_safe_mode: bool = os.getenv('SW_AGENT_LOG_REPORTER_SAFE_MODE') == 'True'
 log_reporter_max_buffer_size: int = int(os.getenv('SW_AGENT_LOG_REPORTER_BUFFER_SIZE') or '10000')
 log_reporter_level: str = os.getenv('SW_AGENT_LOG_REPORTER_LEVEL') or 'WARNING'
@@ -87,10 +74,26 @@ log_reporter_layout: str = os.getenv('SW_AGENT_LOG_REPORTER_LAYOUT') or \
 cause_exception_depth: int = int(os.getenv('SW_AGENT_CAUSE_EXCEPTION_DEPTH') or '10')
 
 # meter reporter configurations
-meter_reporter_active: bool = os.getenv('SW_AGENT_METER_REPORTER_ACTIVE') == 'True'
+meter_reporter_active: bool = os.getenv('SW_AGENT_METER_REPORTER_ACTIVE') != 'False'
 meter_reporter_max_buffer_size: int = int(os.getenv('SW_AGENT_METER_REPORTER_BUFFER_SIZE') or '10000')
-meter_reporter_peroid: int = int(os.getenv('SW_AGENT_METER_REPORTER_PEROID') or '20')
-pvm_meter_reporter_active: bool = os.getenv('SW_AGENT_PVM_METER_REPORTER_ACTIVE') == 'True'
+meter_reporter_period: int = int(os.getenv('SW_AGENT_METER_REPORTER_PERIOD') or '20')
+pvm_meter_reporter_active: bool = os.getenv('SW_AGENT_PVM_METER_REPORTER_ACTIVE') != 'False'
+
+
+# Plugin configurations
+sql_parameters_length: int = int(os.getenv('SW_SQL_PARAMETERS_LENGTH') or '0')
+pymongo_trace_parameters: bool = os.getenv('SW_PYMONGO_TRACE_PARAMETERS') == 'True'
+pymongo_parameters_max_length: int = int(os.getenv('SW_PYMONGO_PARAMETERS_MAX_LENGTH') or '512')
+elasticsearch_trace_dsl: bool = os.getenv('SW_ELASTICSEARCH_TRACE_DSL') == 'True'
+http_params_length_threshold: int = int(os.getenv('SW_HTTP_PARAMS_LENGTH_THRESHOLD') or '1024')
+http_ignore_method: str = os.getenv('SW_HTTP_IGNORE_METHOD', '').upper()
+flask_collect_http_params: bool = os.getenv('SW_FLASK_COLLECT_HTTP_PARAMS') == 'True'
+sanic_collect_http_params: bool = os.getenv('SW_SANIC_COLLECT_HTTP_PARAMS') == 'True'
+django_collect_http_params: bool = os.getenv('SW_DJANGO_COLLECT_HTTP_PARAMS') == 'True'
+fastapi_collect_http_params: bool = os.getenv('SW_FASTAPI_COLLECT_HTTP_PARAMS') == 'True'
+bottle_collect_http_params: bool = os.getenv('SW_BOTTLE_COLLECT_HTTP_PARAMS') == 'True'
+celery_parameters_length: int = int(os.getenv('SW_CELERY_PARAMETERS_LENGTH') or '512')
+
 
 options = {key for key in globals() if key not in options}  # THIS MUST FOLLOW DIRECTLY AFTER LIST OF CONFIG OPTIONS!
 
diff --git a/skywalking/meter/meter_service.py b/skywalking/meter/meter_service.py
index 2f15873..fc7608f 100644
--- a/skywalking/meter/meter_service.py
+++ b/skywalking/meter/meter_service.py
@@ -22,7 +22,7 @@ from skywalking import config
 from skywalking import agent
 from skywalking.meter.meter import BaseMeter
 from skywalking.utils.time import current_milli_time
-from skywalking.config import meter_reporter_peroid
+from skywalking.config import meter_reporter_period
 
 
 class MeterService(Thread):
@@ -50,5 +50,5 @@ class MeterService(Thread):
 
     def run(self):
         while True:
-            time.sleep(meter_reporter_peroid)
+            time.sleep(meter_reporter_period)
             self.send()