Remove configuration debts before we release 1.0.0 (#273)

Author: Superskyyy

.github/PULL_REQUEST_TEMPLATE

@@ -27,6 +27,7 @@
 - [ ] Update the documentation to include this new feature.
 - [ ] Tests(including UT, IT, E2E) are added to verify the new feature.
 - [ ] If it's UI related, attach the screenshots below.
+- [ ] I have rebuilt the `Configuration.md` documentation by running `make doc-gen`
      ==== 🆕 Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist 👆 ==== -->
 
 <!-- ==== 📱 Remove this line WHEN AND ONLY WHEN you're adding or modifying a plugin instrumentation, follow the checklist 👇 ====

CHANGELOG.md

@@ -1,11 +1,19 @@
 ## Change Logs
 
 ### 1.0.0
+
+- **Important Note and Breaking Changes:**
+  - Python 3.6 is no longer supported and may not function properly.
+  - A number of configuration options (mostly environment variables) are renamed to follow the convention of
+  'SW_AGENT' prefixes, please check with the latest official documentation before upgrading. (#273)
+  
+  https://skywalking.apache.org/docs/skywalking-python/v1.0.0/en/setup/configuration/
+  - All agent core capabilities are now covered by test cases and enabled by default (Trace, Log, PVM runtime metrics, Profiler)
+
+
 - Feature:
-  - Drop support for Python 3.6
-  - Add support for Python 3.11 (Pending)
-  - Add MeterReportService (gRPC, Kafka reporter) (default:disabled) (#231, #236, #241, #243)
-  - Add reporter for PVM runtime metrics (default:disabled) (#238, #247)
+  - Add MeterReportService (gRPC, Kafka reporter) (default:enabled) (#231, #236, #241, #243)
+  - Add reporter for PVM runtime metrics (default:enabled) (#238, #247)
   - Add Greenlet profiler (#246)
   - Add test and support for Python Slim base images (#249)
   - Add support for the tags of Virtual Cache for Redis (#263)
@@ -29,13 +37,15 @@
   - Enforce tag class type conversion (#262)
   - Fix sw_logging (log reporter) potentially throw exception leading to traceback confusion (#267)
   - Avoid reporting meaningless tracecontext with logs when there's no active span, UI will now show empty traceID (#272)
+  - Fix exception handler in profile_context (#273)
 
 - Docs:
   - New documentation on how to test locally (#222)
   - 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)
+  - New configuration documentation generator (#273) 
 
 - Others:
   - Pin CI SkyWalking License Eye (#221)

Makefile

@@ -78,6 +78,7 @@ fix:
 .PHONY: doc-gen
 doc-gen: gen
 	poetry run python3 tools/plugin_doc_gen.py
+	poetry run python3 tools/config_doc_gen.py
 
 .PHONY: check-doc-gen
 check-doc-gen: doc-gen

README.md

@@ -21,13 +21,13 @@
 
 ## 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                            |
+| Reporter  | Supported?      | Details                                                    | 
+|:----------|:----------------|:-----------------------------------------------------------|
+| Trace     | ✅ (default: ON) | Automatic instrumentation + Manual SDK                     |            
+| Log       | ✅ (default: ON) | 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
 

docs/README.md

@@ -17,13 +17,13 @@ This documentation covers a number of ways to set up the Python agent for variou
 
 The following table demonstrates the currently supported telemetry collection capabilities in SkyWalking Python agent:
 
-| 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                            |
+| Reporter  | Supported?      | Details                                                    | 
+|:----------|:----------------|:-----------------------------------------------------------|
+| Trace     | ✅ (default: ON) | Automatic instrumentation + Manual SDK                     |            
+| Log       | ✅ (default: ON) | 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                            |
 
 
 ## Live Demo

docs/en/contribution/How-to-develop-plugin.md

@@ -20,7 +20,7 @@ You can always take [the existing plugins](../setup/Plugins.md) as examples, whi
    ```
 4. Every plugin requires a corresponding test under `tests/plugin` before it can be merged, refer to the [Plugin Test Guide](How-to-test-plugin.md) when writing a plugin test.
 5. Update the [Supported Plugin List](../setup/Plugins.md).
-6. Add the environment variables to [Environment Variable list](../setup/EnvVars.md) if any.
+6. Add the environment variables to [Environment Variable list](../setup/Configuration.md) if any.
 
 ## Steps after coding
 

docs/en/setup/CLI.md

@@ -50,7 +50,7 @@ Sometimes you don't actually need the agent to monitor anything in a child proce
 
 If you do not need the agent to get loaded for application child processes, you can turn off the behavior by setting an environment variable.
 
-`SW_PYTHON_BOOTSTRAP_PROPAGATE` to `False`
+`SW_AGENT_SW_PYTHON_BOOTSTRAP_PROPAGATE` to `False`
 
 Note the auto bootstrap depends on the environment inherited by child processes, 
 thus prepending a new sitecustomize path to or removing the loader path from the `PYTHONPATH` could prevent the agent from loading in a child process. 
@@ -62,7 +62,7 @@ You would normally want to provide additional configurations other than the defa
 #### Through environment variables
 
 The currently supported method is to provide the environment variables listed 
-and explained in the [Environment Variables List](EnvVars.md).
+and explained in the [Environment Variables List](Configuration.md).
 
 #### Through a sw-config.yaml