Add proto-buf definitions for php-fpm metrics

nginx · Aug 31, 2023 · 93d1dc4 · 93d1dc4
1 parent d701385
commit 93d1dc4
Show file tree

Hide file tree

Showing 9 changed files with 1,868 additions and 619 deletions.
diff --git a/docs/proto/proto.md b/docs/proto/proto.md
@@ -108,8 +108,10 @@
     - [PhpFpmDetails](#f5-nginx-agent-sdk-PhpFpmDetails)
     - [PhpFpmHealth](#f5-nginx-agent-sdk-PhpFpmHealth)
     - [PhpFpmPool](#f5-nginx-agent-sdk-PhpFpmPool)
+    - [PhpFpmType](#f5-nginx-agent-sdk-PhpFpmType)
 
     - [PhpFpmHealth.PhpFpmHealthStatus](#f5-nginx-agent-sdk-PhpFpmHealth-PhpFpmHealthStatus)
+    - [PhpFpmType.PhpFpmProcessType](#f5-nginx-agent-sdk-PhpFpmType-PhpFpmProcessType)
 
 - [Scalar Value Types](#scalar-value-types)
 
@@ -1556,20 +1558,20 @@ PhpFpmDetails registers a phpfpm master process &#43; child pools
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| type | [string](#string) |  |  |
-| uuid | [string](#string) |  |  |
-| local_id | [string](#string) |  |  |
-| name | [string](#string) |  |  |
-| cmd | [string](#string) |  |  |
-| conf_path | [string](#string) |  |  |
-| bin_path | [string](#string) |  |  |
-| version | [string](#string) |  |  |
-| version_line | [string](#string) |  |  |
-| pid | [int32](#int32) |  |  |
-| agent | [string](#string) |  |  |
-| children | [PhpFpmPool](#f5-nginx-agent-sdk-PhpFpmPool) | repeated |  |
-| workers | [int32](#int32) |  |  |
-| health | [PhpFpmHealth](#f5-nginx-agent-sdk-PhpFpmHealth) |  |  |
+| type | [PhpFpmType](#f5-nginx-agent-sdk-PhpFpmType) |  | PhpFpm process type |
+| uuid | [string](#string) |  | System ID |
+| php_id | [string](#string) |  | PhpFpm ID |
+| name | [string](#string) |  | PhpFpm process name |
+| cmd | [string](#string) |  | PhpFpm process descpription Example: php-fpm: master process (/etc/php/7.4/fpm/php-fpm.conf) |
+| conf_path | [string](#string) |  | Location of PhpFpm config path Example: /etc/php/7.4/fpm/php-fpm.conf |
+| process_path | [string](#string) |  | Location of PhpFpm binary path Example: /usr/sbin/php-fpm7.4 |
+| version | [string](#string) |  | PhpFpm version |
+| version_line | [string](#string) |  | PhpFpm version line Example: PHP 7.4.33 (fpm-fcgi) (built: Feb 14 2023 18:31:23) |
+| pid | [int32](#int32) |  | PhpFpm process id |
+| agent | [string](#string) |  | NGINX agent version |
+| children | [PhpFpmPool](#f5-nginx-agent-sdk-PhpFpmPool) | repeated | PhpFpm children process |
+| workers | [int32](#int32) |  | PhpFpm master process total workers/children |
+| health | [PhpFpmHealth](#f5-nginx-agent-sdk-PhpFpmHealth) |  | PhpFpm master process health |
 
 
 
@@ -1584,9 +1586,9 @@ PhpFpmHealth reports the health details of PHPFPM process
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| system_id | [string](#string) |  |  |
-| phpfpm_health_status | [PhpFpmHealth.PhpFpmHealthStatus](#f5-nginx-agent-sdk-PhpFpmHealth-PhpFpmHealthStatus) |  |  |
-| degraded_reason | [string](#string) |  |  |
+| system_id | [string](#string) |  | System ID |
+| phpfpm_health_status | [PhpFpmHealth.PhpFpmHealthStatus](#f5-nginx-agent-sdk-PhpFpmHealth-PhpFpmHealthStatus) |  | PhpFpm health status |
+| degraded_reason | [string](#string) |  | Provides an error message of why PhpFpm is degraded |
 
 
 
@@ -1601,17 +1603,32 @@ PhpFpmPool registers one of the worker pools of a Php-Fpm master process
 
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
-| type | [string](#string) |  |  |
-| uuid | [string](#string) |  |  |
-| local_id | [string](#string) |  |  |
-| name | [string](#string) |  |  |
-| display_name | [string](#string) |  |  |
-| parent_local_id | [string](#string) |  |  |
-| listen | [string](#string) |  |  |
-| flisten | [string](#string) |  |  |
-| status_path | [string](#string) |  |  |
-| can_have_children | [bool](#bool) |  |  |
-| agent | [string](#string) |  |  |
+| type | [PhpFpmType](#f5-nginx-agent-sdk-PhpFpmType) |  | PhpFpm process type (e.g. phpfpm-pool) |
+| uuid | [string](#string) |  | System ID |
+| php_id | [string](#string) |  | PhpFpm ID |
+| name | [string](#string) |  | PhpFpm process name |
+| display_name | [string](#string) |  | PhpFpm display name Example: phpfpm master @ Ubuntu |
+| parent_php_id | [string](#string) |  | Phpfpm master process ID |
+| listen | [string](#string) |  | Location for PhpFpm process to listen to connections |
+| flisten | [string](#string) |  | PhpFpm formatted listen |
+| status_path | [string](#string) |  | PhpFpm status path |
+| can_have_children | [bool](#bool) |  | Provides info on if PhpFpm process can have child |
+| agent | [string](#string) |  | NGINX agent version |
+
+
+
+
+
+
+<a name="f5-nginx-agent-sdk-PhpFpmType"></a>
+
+### PhpFpmType
+Represents PhpFpm process type
+
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| type | [PhpFpmType.PhpFpmProcessType](#f5-nginx-agent-sdk-PhpFpmType-PhpFpmProcessType) |  | Type of PhpFpm process |
 
 
 
@@ -1623,13 +1640,25 @@ PhpFpmPool registers one of the worker pools of a Php-Fpm master process
 <a name="f5-nginx-agent-sdk-PhpFpmHealth-PhpFpmHealthStatus"></a>
 
 ### PhpFpmHealth.PhpFpmHealthStatus
+Status enum
 
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+| UNKNOWN | 0 | Unknown status |
+| ACTIVE | 1 | Active status |
+| DEGRADED | 2 | Degraded status |
+
+
+
+<a name="f5-nginx-agent-sdk-PhpFpmType-PhpFpmProcessType"></a>
+
+### PhpFpmType.PhpFpmProcessType
+Status enum
 
 | Name | Number | Description |
 | ---- | ------ | ----------- |
-| UNKNOWN | 0 |  |
-| ACTIVE | 1 |  |
-| DEGRADED | 2 |  |
+| PHPFPM | 0 | Master |
+| PHPFPM_POOL | 1 | Child |