Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add proto-buf definitions for php-fpm metrics #452

Merged
merged 2 commits into from
Sep 7, 2023
Merged

Add proto-buf definitions for php-fpm metrics #452

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d701385
Add protobuf definitions for php-fpm metrics
achawla2012 Aug 24, 2023
7eb1e8b
Add proto-buf definitions for php-fpm metrics
achawla2012 Aug 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
107 changes: 107 additions & 0 deletions docs/proto/proto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,13 @@
- [NginxHealth.NginxStatus](#f5-nginx-agent-sdk-NginxHealth-NginxStatus)
- [NginxSslMetaData.NginxSslType](#f5-nginx-agent-sdk-NginxSslMetaData-NginxSslType)

- [phpfpm.proto](#phpfpm-proto)
- [PhpFpmDetails](#f5-nginx-agent-sdk-PhpFpmDetails)
- [PhpFpmHealth](#f5-nginx-agent-sdk-PhpFpmHealth)
- [PhpFpmPool](#f5-nginx-agent-sdk-PhpFpmPool)

- [PhpFpmHealth.PhpFpmHealthStatus](#f5-nginx-agent-sdk-PhpFpmHealth-PhpFpmHealthStatus)

- [Scalar Value Types](#scalar-value-types)


Expand Down Expand Up @@ -939,6 +946,7 @@ Represents dataplane software details which contains details for additional soft
| ----- | ---- | ----- | ----------- |
| app_protect_waf_details | [AppProtectWAFDetails](#f5-nginx-agent-sdk-AppProtectWAFDetails) | | App Protect WAF software details |
| nginx_details | [NginxDetails](#f5-nginx-agent-sdk-NginxDetails) | | NGINX software details |
| php_fpm_details | [PhpFpmDetails](#f5-nginx-agent-sdk-PhpFpmDetails) | | PhpFpmDetails software details |



Expand Down Expand Up @@ -1533,6 +1541,105 @@ SSL type enum



<a name="phpfpm-proto"></a>
<p align="right"><a href="#top">Top</a></p>

## phpfpm.proto



<a name="f5-nginx-agent-sdk-PhpFpmDetails"></a>

### PhpFpmDetails
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) | | |






<a name="f5-nginx-agent-sdk-PhpFpmHealth"></a>

### PhpFpmHealth
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) | | |






<a name="f5-nginx-agent-sdk-PhpFpmPool"></a>

### PhpFpmPool
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) | | |








<a name="f5-nginx-agent-sdk-PhpFpmHealth-PhpFpmHealthStatus"></a>

### PhpFpmHealth.PhpFpmHealthStatus


| Name | Number | Description |
| ---- | ------ | ----------- |
| UNKNOWN | 0 | |
| ACTIVE | 1 | |
| DEGRADED | 2 | |










## Scalar Value Types

| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
Expand Down
112 changes: 98 additions & 14 deletions sdk/proto/dp_software_details.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions sdk/proto/dp_software_details.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ package f5.nginx.agent.sdk;
import "gogo.proto";
import "nap.proto";
import "nginx.proto";
import "phpfpm.proto";

option go_package = "github.com/nginx/agent/sdk/v2/proto;proto";

Expand All @@ -14,5 +15,7 @@ message DataplaneSoftwareDetails {
AppProtectWAFDetails app_protect_waf_details = 1 [(gogoproto.jsontag) = "app_protect_waf_details"];
// NGINX software details
NginxDetails nginx_details = 2 [(gogoproto.jsontag) = "nginx_details"];
// PhpFpmDetails software details
PhpFpmDetails php_fpm_details = 3 [(gogoproto.jsontag) = "php_fpm_details"];
}
}
Loading