You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/defining-a-custom-metric-87e657e.md
+54-7
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Define your own metrics to scale applications based on your requirements.
12
12
13
13
As an alternative to the standard metrics provided by the Application Autoscaler, you can also define custom metrics such as memory consumed in megabytes or in percentage, response time, and throughput for scaling. Custom metrics offer more flexibility, so that you can scale applications based on your own requirements.
14
14
15
-
To use custom metrics, you need to perform the following tasks:
15
+
To use custom metrics, your application needs to perform the following tasks:
16
16
17
17
1. Report a custom metric to the Application Autoscaler by defining a policy.
18
18
@@ -35,40 +35,87 @@ The following example shows a policy with a custom metric:
35
35
"adjustment":"+1"
36
36
}
37
37
]
38
-
38
+
}
39
39
```
40
40
41
41
> ### Note:
42
42
> The metric type used for custom metrics must not be any of the standard metric types.
43
43
44
44
> ### Tip:
45
45
> We recommend a minimum duration of one minute between successive emissions of a custom metric.
46
+
>
47
+
> As part of the binding process, the Application Autoscaler service instance provides necessary credentials to emit custom metrics.
48
+
49
+
The generation of these credentials is based on the credential type parameter in the service binding. The supported credential types are binding-secret and x509. If no credential type is provided, binding-secret is used as the default credential type.
46
50
47
51
48
52
49
53
## Procedure
50
54
51
55
1. Bind your application with the Application Autoscaler service instance using a policy that contains custom metrics scaling rule.
52
56
57
+
**sample policy.json with credential Type as x509**
58
+
59
+
> ### Sample Code:
60
+
> ```
61
+
>
62
+
> {
63
+
> "instance_min_count":1,
64
+
> "instance_max_count":4,
65
+
> "scaling_rules":[
66
+
> {
67
+
> "metric_type":"jobqueue",
68
+
> "breach_duration_secs":60,
69
+
> "threshold":100,
70
+
> "operator":">=",
71
+
> "cool_down_secs":120,
72
+
> "adjustment":"+1"
73
+
> }
74
+
> ],
75
+
> "credential-type": "x509"
76
+
> }
77
+
> ```
78
+
79
+
**bind the service instance with the scaling policy**
3. Use the X.509 certificate in the file with the path provided in the environment variable `CF_INSTANCE_CERT`, and the private key in the file with the path provided in the environment variable `CF_INSTANCE_KEY` as certificate and key for mutual TLS authentication \(mTLS\) with the base URL provided in the `mtls_url` of the service binding.
99
+
3.
100
+
101
+
**Authenticate with X.509 Certificate:**
102
+
103
+
Your application requires base url, certificate and a private key for mutual TLS authentication \\\(mTLS\\\).
104
+
105
+
- Use the base URL provided in the `mtls_url` of the service binding.
106
+
107
+
- Use the X.509 certificate and private key from the paths provided in the environment variables `CF_INSTANCE_CERT` and `CF_INSTANCE_KEY` respectively.
108
+
109
+
110
+
> ### Note:
111
+
> The environment variables `CF_INSTANCE_CERT` and `CF_INSTANCE_KEY` are not shown in the cockpit or using the `cf env` command. They are only visible inside the running application container.
112
+
113
+
**Authenticate with Basic Authentication \(Deprecated, do not use\):**
67
114
68
115
> ### Note:
69
116
> The X.509 certificate and private key pair are valid for 24 hours. At least 20 minutes before expiration, they are regenerated and new files replace the existing files. Make sure that your code reloads the X.509 certificate and private key pair if they are expired. See [Using Instance Identity Credentials](https://docs.cloudfoundry.org/devguide/deploy-apps/instance-identity.html) in the Cloud Foundry Documentation.
70
117
71
-
`url`, `username`, and `password` are provided for backwards compatibility with the HTTP basic authentication scheme and should not be used going forward.
118
+
`url`, `username`, and `password` in the application environment are provided for backwards compatibility with the HTTP basic authentication scheme and should not be used going forward. If your application still needs to authenticate with basic authentication, use credential-type binding-secret in the service binding and plan to migrate to mTLS \(\`x509\`\) authentication until 2025-01-23.
72
119
73
120
4. Push custom metrics at an interval of your choice using APIs. For the REST API specification, see [Application Autoscaler custom metrics API](https://api.sap.com/api/ApplicationAutoscalerCustomMetricsAPI/resource).
0 commit comments