Open
新增英文readme文件 #93
xutaoAdd on Aug 17
新增英文readme文件 #93
Open
Merged fromxutao216/observability_0817mainintoopenUBMC/observabilitymain
Total: 1 files changed+106-0
| @@ -0,0 +1,106 @@ | |||
| 1 | +# Observability | ||
| 2 | + | ||
| 3 | +Provides the BMC observability service. | ||
| 4 | + | ||
| 5 | +## Project Structure | ||
| 6 | + | ||
| 7 | +``` | ||
| 8 | +. | ||
| 9 | +├── src/ # Source code directory | ||
| 10 | +│ └── lualib-src/ # Lua library source code | ||
| 11 | +│ └── otel/ # OpenTelemetry implementation | ||
| 12 | +│ ├── common/ # Common components and tools | ||
| 13 | +│ ├── logs/ # Log collection and processing | ||
| 14 | +│ ├── metrics/ # Metric collection and processing | ||
| 15 | +│ ├── trace/ # Distributed tracing | ||
| 16 | +│ ├── utils/ # Utility functions | ||
| 17 | +│ └── CMakeLists.txt | ||
| 18 | +├── test/ # Test directory | ||
| 19 | +│ ├── integration/ # Integration test | ||
| 20 | +│ ├── unit/ # Unit test | ||
| 21 | +│ └── .test_temp_data/ # Test temporary data | ||
| 22 | +├── proto/ # Protocol Buffers definition file | ||
| 23 | +├── gen/ # Generated code | ||
| 24 | +├── mds/ # Model definition file | ||
| 25 | +├── temp/ # Temporary file directory | ||
| 26 | +├── .vscode/ # VSCode configuration | ||
| 27 | +├── CMakeLists.txt # Top-level CMake configuration | ||
| 28 | +├── Makefile # Build script | ||
| 29 | +├── conanfile.py # Conan package management configuration | ||
| 30 | +├── conanbase.py # Conan basic configuration | ||
| 31 | +├── permissions.ini # Permission configuration file | ||
| 32 | +├── LICENSE # License file | ||
| 33 | +└── CHANGELOG.md # Change log | ||
| 34 | +``` | ||
| 35 | + | ||
| 36 | +## Function Module Description | ||
| 37 | + | ||
| 38 | +### Source Code (src/) | ||
| 39 | + | ||
| 40 | +#### OpenTelemetry Implementation (otel/) | ||
| 41 | +- Common components (common/) | ||
| 42 | + - Provides the infrastructure and shared components of OpenTelemetry. | ||
| 43 | + - Provides core functions such as configuration management and context propagation. | ||
| 44 | + | ||
| 45 | +- Log module (logs/) | ||
| 46 | + - Collects and processes OpenTelemetry logs. | ||
| 47 | + - Supports structured log formats. | ||
| 48 | + - Parses and converts logs. | ||
| 49 | + | ||
| 50 | +- Metric module (metrics/) | ||
| 51 | + - Collects and processes OpenTelemetry metrics. | ||
| 52 | + - Supports metric types such as counters and dashboards. | ||
| 53 | + - Provides metric aggregation and export functions. | ||
| 54 | + | ||
| 55 | +- Trace module (trace/) | ||
| 56 | + - Implements distributed tracing. | ||
| 57 | + - Supports request link tracing. | ||
| 58 | + - Provides sampling and context propagation. | ||
| 59 | + | ||
| 60 | +- Utility functions (utils/) | ||
| 61 | + - Provides common utility functions. | ||
| 62 | + - Contains auxiliary methods and utility classes. | ||
| 63 | + | ||
| 64 | +### Test (test/) | ||
| 65 | + | ||
| 66 | +- Unit test (unit/) | ||
| 67 | + - Tests the independent functions of each module. | ||
| 68 | + - Contains test cases and test data. | ||
| 69 | + | ||
| 70 | +- Integration test (integration/) | ||
| 71 | + - Tests the interaction between modules. | ||
| 72 | + - Verifies the overall system functions. | ||
| 73 | + | ||
| 74 | +### Other Directories | ||
| 75 | + | ||
| 76 | +- proto/: Protocol Buffers definition file, used for data serialization | ||
| 77 | +- gen/: automatically generated code file | ||
| 78 | +- mds/: model definition file | ||
| 79 | +- temp/: directory for storing temporary files | ||
| 80 | + | ||
| 81 | +## Build System | ||
| 82 | + | ||
| 83 | +The project uses the following build tools: | ||
| 84 | + | ||
| 85 | +- CMake: main build system | ||
| 86 | + - Top-level `CMakeLists.txt`: overall project configuration | ||
| 87 | + - `otel/CMakeLists.txt`: OpenTelemetry module configuration | ||
| 88 | + | ||
| 89 | +- Conan: package management | ||
| 90 | + - `conanfile.py`: package dependency configuration | ||
| 91 | + - `conanbase.py`: basic build configuration | ||
| 92 | + | ||
| 93 | +- Makefile: provides convenient build commands | ||
| 94 | + | ||
| 95 | +## Development Environment | ||
| 96 | + | ||
| 97 | +- VS Code configuration is located in the `.vscode/` directory. | ||
| 98 | +- Permission configuration is in the `permissions.ini` file. | ||
| 99 | + | ||
| 100 | +## License | ||
| 101 | + | ||
| 102 | +For details, see [LICENSE](https://gitcode.com/openUBMC/observability/blob/main/LICENSE). | ||
| 103 | + | ||
| 104 | +## Change Logs | ||
| 105 | + | ||
| 106 | +For details, see [CHANGELOG.md](https://gitcode.com/openUBMC/observability/blob/main/CHANGELOG.md). | ||