Skip to content

Commit e18a469

Browse files
authored
Merge pull request #4557 from JoshVanL/ref-api-metadata-scheduler
Reference: Metadata API Scheduler
2 parents 9c849cd + e7f95a0 commit e18a469

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

daprdocs/content/en/reference/api/metadata_api.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ A list of features enabled via Configuration spec (including build-time override
3737
### App connection details
3838
The metadata API returns information related to Dapr's connection to the app. This includes the app port, protocol, host, max concurrency, along with health check details.
3939

40+
### Scheduler connection details
41+
Information related to the connection to one or more scheduler hosts.
42+
4043
### Attributes
4144

4245
The metadata API allows you to store additional attribute information in the format of key-value pairs. These are ephemeral in-memory and are not persisted if a sidecar is reloaded. This information should be added at the time of a sidecar creation (for example, after the application has started).
@@ -82,6 +85,7 @@ components | [Metadata API Response Component](#metadataapiresponsec
8285
httpEndpoints | [Metadata API Response HttpEndpoint](#metadataapiresponsehttpendpoint)[] | A json encoded array of loaded HttpEndpoints metadata.
8386
subscriptions | [Metadata API Response Subscription](#metadataapiresponsesubscription)[] | A json encoded array of pub/sub subscriptions metadata.
8487
appConnectionProperties| [Metadata API Response AppConnectionProperties](#metadataapiresponseappconnectionproperties) | A json encoded object of app connection properties.
88+
scheduler | [Metadata API Response Scheduler](#metadataapiresponsescheduler) | A json encoded object of scheduler connection properties.
8589

8690
<a id="metadataapiresponseactor"></a>**Metadata API Response Registered Actor**
8791

@@ -142,6 +146,12 @@ healthProbeInterval | string | Time between each health probe, in go duration fo
142146
healthProbeTimeout | string | Timeout for each health probe, in go duration format.
143147
healthThreshold | integer | Max number of failed health probes before the app is considered unhealthy.
144148

149+
<a id="metadataapiresponsescheduler"></a>**Metadata API Response Scheduler**
150+
151+
Name | Type | Description
152+
---- | ---- | -----------
153+
connected_addresses | string[] | List of strings representing the addresses of the conntected scheduler hosts.
154+
145155

146156
### Examples
147157

@@ -215,6 +225,13 @@ curl http://localhost:3500/v1.0/metadata
215225
"healthProbeTimeout": "500ms",
216226
"healthThreshold": 3
217227
}
228+
},
229+
"scheduler": {
230+
"connected_addresses": [
231+
"10.244.0.47:50006",
232+
"10.244.0.48:50006",
233+
"10.244.0.49:50006"
234+
]
218235
}
219236
}
220237
```
@@ -338,6 +355,13 @@ Get the metadata information to confirm your custom attribute was added:
338355
"healthProbeTimeout": "500ms",
339356
"healthThreshold": 3
340357
}
358+
},
359+
"scheduler": {
360+
"connected_addresses": [
361+
"10.244.0.47:50006",
362+
"10.244.0.48:50006",
363+
"10.244.0.49:50006"
364+
]
341365
}
342366
}
343367
```

0 commit comments

Comments
 (0)