-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FINERACT-2081 add descriptions to property file values
- Loading branch information
Showing
9 changed files
with
274 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
fineract-doc/src/docs/en/chapters/appendix/properties-cloud-aws.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
= AWS Configuration Properties | ||
|
||
For further understanding of the configuration properties related to AWS, refer to https://docs.awspring.io/spring-cloud-aws/docs/current/reference/html/index.html[Spring Cloud AWS documentation]. | ||
|
||
.AWS Configuration Properties | ||
|=== | ||
|Name |Env Variable |Default Value |Description | ||
|
||
|spring.cloud.aws.endpoint | ||
|FINERACT_AWS_ENDPOINT | ||
| | ||
|The AWS service endpoint. | ||
|
||
|spring.cloud.aws.region.static | ||
|FINERACT_AWS_REGION_STATIC | ||
|us-east-1 | ||
|The static region for AWS services. | ||
|
||
|spring.cloud.aws.credentials.access-key | ||
|FINERACT_AWS_CREDENTIALS_ACCESS_KEY | ||
| | ||
|The AWS access key. | ||
|
||
|spring.cloud.aws.credentials.secret-key | ||
|FINERACT_AWS_CREDENTIALS_SECRET_KEY | ||
| | ||
|The AWS secret key. | ||
|
||
|spring.cloud.aws.credentials.instance-profile | ||
|FINERACT_AWS_CREDENTIALS_INSTANCE_PROFILE | ||
|false | ||
|Whether to use the instance profile for credentials. | ||
|
||
|spring.cloud.aws.credentials.profile.name | ||
|FINERACT_AWS_CREDENTIALS_PROFILE_NAME | ||
| | ||
|The name of the AWS credentials profile. | ||
|
||
|spring.cloud.aws.credentials.profile.path | ||
|FINERACT_AWS_CREDENTIALS_PROFILE_PATH | ||
| | ||
|The path to the AWS credentials profile. | ||
|=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
64 changes: 64 additions & 0 deletions
64
fineract-doc/src/docs/en/chapters/appendix/properties-metrics.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
= Metrics Properties | ||
|
||
For further understanding of the configurations properties related to metrics, refer to https://docs.spring.io/spring-boot/docs/2.0.5.RELEASE/reference/html/production-ready-metrics.html[Springboot metrics docs] | ||
|
||
.Metrics Properties | ||
|=== | ||
|Name |Env Variable |Default Value |Description | ||
|
||
|
||
|management.info.git.mode | ||
| | ||
|FULL | ||
|Mode for displaying Git information in the `/info` endpoint. | ||
|
||
|management.endpoints.web.exposure.include | ||
|FINERACT_MANAGEMENT_ENDPOINT_WEB_EXPOSURE_INCLUDE | ||
|health,info,prometheus | ||
|Comma-separated list of endpoints that should be exposed over the web. | ||
|
||
|management.tracing.enabled | ||
|FINERACT_MANAGEMENT_METRICS_TAGS_APPLICATION | ||
|fineract | ||
|Whether tracing is enabled. | ||
|
||
|management.metrics.distribution.percentiles-histogram.http.server.requests | ||
|FINERACT_MANAGEMENT_METRICS_DISTRIBUTION_HTTP_SERVER_REQUESTS | ||
|false | ||
|Whether to publish percentile histograms for HTTP server requests. | ||
|
||
|management.otlp.metrics.export.url | ||
|FINERACT_MANAGEMENT_OLTP_METRICS_EXPORT_URL | ||
|http://tempo:4318/v1/traces | ||
|URL to export OTLP metrics. | ||
|
||
|management.otlp.metrics.export.aggregationTemporality | ||
|FINERACT_MANAGEMENT_OLTP_METRICS_EXPORT_AGGREGATION_TEMPORALITY | ||
|cumulative | ||
|Aggregation temporality for OTLP metrics export. | ||
|
||
|management.prometheus.metrics.export.enabled | ||
|FINERACT_MANAGEMENT_PROMETHEUS_ENABLED | ||
|false | ||
|Whether to enable Prometheus metrics export. | ||
|
||
|spring.cloud.aws.cloudwatch.enabled | ||
|FINERACT_MANAGEMENT_CLOUDWATCH_ENABLED | ||
|false | ||
|Whether to enable AWS CloudWatch integration. | ||
|
||
|management.metrics.export.cloudwatch.enabled | ||
|FINERACT_MANAGEMENT_CLOUDWATCH_ENABLED | ||
|false | ||
|Whether to enable CloudWatch metrics export. | ||
|
||
|management.metrics.export.cloudwatch.namespace | ||
|FINERACT_MANAGEMENT_CLOUDWATCH_NAMESPACE | ||
|fineract | ||
|Namespace for CloudWatch metrics. | ||
|
||
|management.metrics.export.cloudwatch.step | ||
|FINERACT_MANAGEMENT_CLOUDWATCH_STEP | ||
|1m | ||
|Step size for CloudWatch metrics export. | ||
|=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.