Topology - script API
StackState Self-hosted v5.1.x
Last updated
StackState Self-hosted v5.1.x
Last updated
\
Topology.query(query: String)
Query the topology at any point in time. Builder methods available for extracting components, relations and comparing topological queries.
query
- a .
Returns:
AsyncScriptResult[TopologyScriptApiQueryResponse]
at(time: Instant or Timeslice)
- specifes a for which the query should be executed.
Use an instant
to query for transactions that started at a specific timestamp including at any point in the past.
Use the currentTimeslice
to query for all transactions currently started or in progress.
repeatAt(time: Instant)
- repeats the same query but at a different exact .
diff(queryResult: TopologyScriptApiQueryResponse)
- compares this query with another query. A query should be the result of a call to this function.
diffWithPrev(queryResult: TopologyScriptApiQueryResponse)
- compares this query with the last query in the chain. A query should be the result of a call to this function. This builder method is only available after the diff
builder method was called.
components()
- returns a summary of the components. After this builder method no more builder methods can be called.
fullComponents()
- returns the component with all their data. After this builder method no more builder methods can be called.
problems()
- returns problems for a given query along with the root cause and its contributing problems.
relations()
- returns a summary of the relations. After this builder method no more builder methods can be called.
fullRelations()
- returns the relations with all their data. After this builder method no more builder methods can be called.
Get the test environment:
Get the test environment yesterday:
Get test environment one hour ago, two hours ago and three hours ago.
Get the component that differ between the test and production environment:
Get the difference between the test environment one week ago and now:
Get the first root problem's first failing check - likely a major root cause of a problem in the queried topology:
Get all the names of components from the test environment using :