Service Catalog Skill
Use this skill to discover and query Service Catalog entities — services,
databases, operations, database operations, JVMs, JVM GC, Kubernetes pods, and
transactions — and their columnar metrics (latency, error rate, health, resource
usage, etc.) via the v2 Service Catalog API.
CLI Commands
| Command |
Purpose |
Key flags |
cx service-catalog entity-types |
List entity types this account has data for |
- |
cx service-catalog schema <entity-type> |
Columns/labels schema for one entity type |
- |
cx service-catalog entities <entity-type> |
Known entities of one type (e.g. service names) |
- |
cx service-catalog data <entity-type> |
Aggregated column data across every entity of a type |
--start, --end, --column (required, repeatable); --group-by, --filter, --aggregation, --limit, --sort-column, --sort-order |
cx service-catalog entity-data <entity-type> <entity-id> |
Column data for one named entity (drilldown) |
--start, --end, --column (required, repeatable); --group-by, --filter, --aggregation |
- All commands are read-only and support
-o json / -o toon for
structured output.
- Entity type accepts short forms:
service, database, operation,
database-operation, jvm, jvm-gc, k8s-pod, transaction (case-insensitive,
hyphens or underscores). The full proto name (ENTITY_TYPE_K8S_POD) also works.
Unknown values are rejected client-side before any request is made.
--start/--end accept now, now-1h-style relative expressions, or
RFC3339 timestamps.
--column is required and repeatable — discover valid column ids with
cx service-catalog schema <entity-type> first; the API rejects unknown ones.
--filter label=value1,value2 is repeatable across distinct labels only
(filters AND together); combine multiple values for the same label with commas
rather than repeating the flag — repeating a label is rejected client-side.
--aggregation is table (default behavior when combined with --limit/
--sort-column/--sort-order) or timeseries. --limit, --sort-column,
and --sort-order only apply to table — the backend silently ignores them
for timeseries, so the CLI rejects that combination up front rather than
sending a request whose flags are quietly dropped.
entity-data percent-encodes the entity id for you — pass it as returned by
entities (e.g. checkout/api), quoted if it contains /.
Inspection Workflow
Four steps, and only because each one supplies an input the next one requires:
entity-types gives valid <entity-type> values, schema gives valid
--column ids, entities gives the entity-id for a drilldown.
Discover what entity types exist — never guess, they vary by account:
cx service-catalog entity-types -o json
Check the schema for one entity type to find valid column ids and
filterable/groupable labels:
cx service-catalog schema service -o json
List known entities of that type (e.g. service names):
cx service-catalog entities service -o json
Query data — aggregated across all entities, or scoped to one. Column
ids, filter/group-by labels, and entity ids below are placeholders — always
substitute values returned by schema/entities for the entity type in
question, they vary by account and entity type:
cx service-catalog data <entity-type> --start now-1h --end now \
--column <column-id> --column <column-id> -o json
cx service-catalog entity-data <entity-type> <entity-id> --start now-1h --end now \
--column <column-id> -o json
Examples
The commands below use service and k8s-pod for concreteness, but every
<column-id>, <filterable-label>, <groupable-label>, and <entity-id>
must come from that entity type's own schema/entities output — never
assume a column or label from one entity type exists on another.
Top 5 entities by a metric in the last hour
cx service-catalog schema service -o json # discover column ids first
cx service-catalog data service --start now-1h --end now \
--column <column-id> --aggregation table \
--sort-column <column-id> --sort-order desc --limit 5 -o json
Filter to one label value
cx service-catalog schema service -o json # discover filterable_labels first
cx service-catalog data service --start now-1h --end now \
--column <column-id> --column <column-id> \
--filter <filterable-label>=<value> -o json
Group by a label
cx service-catalog schema service -o json # discover groupable_labels first
cx service-catalog data service --start now-1h --end now \
--column <column-id> --group-by <groupable-label> -o json
Kubernetes pod resource saturation
cx service-catalog schema k8s-pod -o json # discover column ids first
cx service-catalog data k8s-pod --start now-1h --end now \
--column <column-id> --column <column-id> --column <column-id> -o json
Latency over time for one entity
cx service-catalog entities service -o json # discover entity ids first
cx service-catalog entity-data service <entity-id> --start now-24h --end now \
--column <column-id> --aggregation timeseries -o json
Just the rows
# Table responses live under .rows; timeseries under .series
cx service-catalog data service --start now-1h --end now \
--column <column-id> -o json | jq '.rows'
Key Principles
- Discover before querying —
entity-types and schema are cheap and
answer "what's valid here" before spending a data/entity-data call on a
guess.
--column values are per-entity-type — a column valid for service may
not exist for k8s-pod; always re-check schema when switching entity types.
- Malformed responses are errors, not silent empty results — a column that
is neither a value nor an error (or both) fails loudly rather than producing
a partial or empty row, so a non-zero exit means investigate, not "no data".
- A column-level error is not a command failure — an individual column can
come back as
{"error": "..."} inside an otherwise successful row (e.g. a
query timeout for just that column); check per-column before assuming the
whole request failed.
table vs timeseries are mutually exclusive result shapes — table
responses are flat rows suitable for -o json | jq '.rows'; timeseries
responses nest datapoints per series and are best consumed as raw JSON rather
than forced into a table.
- Use
-o json with jq for filtering; use -o toon for token-efficient
output in agent contexts.
- Multi-profile fan-out works on every subcommand — repeat
-p <profile> to
compare the same entity type/data across accounts; rows and series are tagged
with profile when more than one is given.
Related Skills
cx-infra — infrastructure resource health (hosts, containers) is a
distinct concept from Service Catalog entity health; use cx-infra for
host/instance-level monitoring and this skill for application/service-level
APM entities.
cx-telemetry-querying — once a service or pod name surfaces from this
skill's commands, pivot to raw telemetry: cx logs "filter $l.subsystemname == '<service>'" or cx search-fields "<name>" -s value to find related log/span
fields. Correlate a latency or error spike with the underlying logs/spans.
cx-alerts — cx alerts list --name "<service-name>" finds alert
definitions matching a service surfaced by this skill.
cx-dashboards — cx dashboards search "<service-name> ..." finds
dashboards built around a service found here.
1---2name: cx-service-catalog3description: >4 Query Coralogix's Service Catalog (APM v2 entities) with the `cx service-catalog`5 CLI — discover entity types, list known entities, check their schema, and pull6 aggregated or timeseries data for services, databases, operations, JVMs, and7 Kubernetes pods. Use when the user asks to "list services", "what entity types8 exist", "show me service latency", "check error rate for a service",9 "which pods are using the most memory", "database operation performance",10 "JVM GC pauses", "service health over time", "compare services by latency",11 "what columns are available for this entity type", "service catalog schema",12 or wants to explore APM entities and their metrics.13metadata:14 source: https://skillmd.com/skills/coralogix/cx-service-catalog15 version: "0.1.0"16---1718# Service Catalog Skill1920Use this skill to discover and query **Service Catalog entities** — services,21databases, operations, database operations, JVMs, JVM GC, Kubernetes pods, and22transactions — and their columnar metrics (latency, error rate, health, resource23usage, etc.) via the v2 Service Catalog API.2425## CLI Commands2627| Command | Purpose | Key flags |28|---|---|---|29| `cx service-catalog entity-types` | List entity types this account has data for | - |30| `cx service-catalog schema <entity-type>` | Columns/labels schema for one entity type | - |31| `cx service-catalog entities <entity-type>` | Known entities of one type (e.g. service names) | - |32| `cx service-catalog data <entity-type>` | Aggregated column data across every entity of a type | `--start`, `--end`, `--column` (required, repeatable); `--group-by`, `--filter`, `--aggregation`, `--limit`, `--sort-column`, `--sort-order` |33| `cx service-catalog entity-data <entity-type> <entity-id>` | Column data for one named entity (drilldown) | `--start`, `--end`, `--column` (required, repeatable); `--group-by`, `--filter`, `--aggregation` |3435- All commands are **read-only** and support `-o json` / `-o toon` for36 structured output.37- **Entity type accepts short forms**: `service`, `database`, `operation`,38 `database-operation`, `jvm`, `jvm-gc`, `k8s-pod`, `transaction` (case-insensitive,39 hyphens or underscores). The full proto name (`ENTITY_TYPE_K8S_POD`) also works.40 Unknown values are rejected client-side before any request is made.41- `--start`/`--end` accept `now`, `now-1h`-style relative expressions, or42 RFC3339 timestamps.43- `--column` is **required** and repeatable — discover valid column ids with44 `cx service-catalog schema <entity-type>` first; the API rejects unknown ones.45- `--filter label=value1,value2` is repeatable **across distinct labels only**46 (filters AND together); combine multiple values for the same label with commas47 rather than repeating the flag — repeating a label is rejected client-side.48- `--aggregation` is `table` (default behavior when combined with `--limit`/49 `--sort-column`/`--sort-order`) or `timeseries`. **`--limit`, `--sort-column`,50 and `--sort-order` only apply to `table`** — the backend silently ignores them51 for `timeseries`, so the CLI rejects that combination up front rather than52 sending a request whose flags are quietly dropped.53- `entity-data` percent-encodes the entity id for you — pass it as returned by54 `entities` (e.g. `checkout/api`), quoted if it contains `/`.5556## Inspection Workflow5758Four steps, and only because each one supplies an input the next one requires:59`entity-types` gives valid `<entity-type>` values, `schema` gives valid60`--column` ids, `entities` gives the `entity-id` for a drilldown.61621. **Discover what entity types exist** — never guess, they vary by account:6364 ```bash65 cx service-catalog entity-types -o json66 ```67682. **Check the schema** for one entity type to find valid column ids and69 filterable/groupable labels:7071 ```bash72 cx service-catalog schema service -o json73 ```74753. **List known entities** of that type (e.g. service names):7677 ```bash78 cx service-catalog entities service -o json79 ```80814. **Query data** — aggregated across all entities, or scoped to one. Column82 ids, filter/group-by labels, and entity ids below are placeholders — always83 substitute values returned by `schema`/`entities` for the entity type in84 question, they vary by account and entity type:8586 ```bash87 cx service-catalog data <entity-type> --start now-1h --end now \88 --column <column-id> --column <column-id> -o json8990 cx service-catalog entity-data <entity-type> <entity-id> --start now-1h --end now \91 --column <column-id> -o json92 ```9394## Examples9596The commands below use `service` and `k8s-pod` for concreteness, but every97`<column-id>`, `<filterable-label>`, `<groupable-label>`, and `<entity-id>`98must come from that entity type's own `schema`/`entities` output — never99assume a column or label from one entity type exists on another.100101### Top 5 entities by a metric in the last hour102103```bash104cx service-catalog schema service -o json # discover column ids first105cx service-catalog data service --start now-1h --end now \106 --column <column-id> --aggregation table \107 --sort-column <column-id> --sort-order desc --limit 5 -o json108```109110### Filter to one label value111112```bash113cx service-catalog schema service -o json # discover filterable_labels first114cx service-catalog data service --start now-1h --end now \115 --column <column-id> --column <column-id> \116 --filter <filterable-label>=<value> -o json117```118119### Group by a label120121```bash122cx service-catalog schema service -o json # discover groupable_labels first123cx service-catalog data service --start now-1h --end now \124 --column <column-id> --group-by <groupable-label> -o json125```126127### Kubernetes pod resource saturation128129```bash130cx service-catalog schema k8s-pod -o json # discover column ids first131cx service-catalog data k8s-pod --start now-1h --end now \132 --column <column-id> --column <column-id> --column <column-id> -o json133```134135### Latency over time for one entity136137```bash138cx service-catalog entities service -o json # discover entity ids first139cx service-catalog entity-data service <entity-id> --start now-24h --end now \140 --column <column-id> --aggregation timeseries -o json141```142143### Just the rows144145```bash146# Table responses live under .rows; timeseries under .series147cx service-catalog data service --start now-1h --end now \148 --column <column-id> -o json | jq '.rows'149```150151## Key Principles152153- **Discover before querying** — `entity-types` and `schema` are cheap and154 answer "what's valid here" before spending a `data`/`entity-data` call on a155 guess.156- **`--column` values are per-entity-type** — a column valid for `service` may157 not exist for `k8s-pod`; always re-check `schema` when switching entity types.158- **Malformed responses are errors, not silent empty results** — a column that159 is neither a value nor an error (or both) fails loudly rather than producing160 a partial or empty row, so a non-zero exit means investigate, not "no data".161- **A column-level error is not a command failure** — an individual column can162 come back as `{"error": "..."}` inside an otherwise successful row (e.g. a163 query timeout for just that column); check per-column before assuming the164 whole request failed.165- **`table` vs `timeseries` are mutually exclusive result shapes** — `table`166 responses are flat rows suitable for `-o json | jq '.rows'`; `timeseries`167 responses nest datapoints per series and are best consumed as raw JSON rather168 than forced into a table.169- **Use `-o json` with `jq`** for filtering; use `-o toon` for token-efficient170 output in agent contexts.171- **Multi-profile fan-out** works on every subcommand — repeat `-p <profile>` to172 compare the same entity type/data across accounts; rows and series are tagged173 with `profile` when more than one is given.174175## Related Skills176177- **`cx-infra`** — infrastructure resource health (hosts, containers) is a178 distinct concept from Service Catalog entity health; use `cx-infra` for179 host/instance-level monitoring and this skill for application/service-level180 APM entities.181- **`cx-telemetry-querying`** — once a service or pod name surfaces from this182 skill's commands, pivot to raw telemetry: `cx logs "filter $l.subsystemname ==183 '<service>'"` or `cx search-fields "<name>" -s value` to find related log/span184 fields. Correlate a latency or error spike with the underlying logs/spans.185- **`cx-alerts`** — `cx alerts list --name "<service-name>"` finds alert186 definitions matching a service surfaced by this skill.187- **`cx-dashboards`** — `cx dashboards search "<service-name> ..."` finds188 dashboards built around a service found here.