Catalog
Last updated
Was this helpful?
1.2
Last updated
Was this helpful?
The Grey Matter Catalog service interfaces with the Fabric mesh xDS interface to provide high level summaries and more easily consumable views of the current state of the mesh. It powers the application and any other applications that need to understand what is present in the mesh.
Multi Zone Management
Human-friendly Service Management
Real-time Service Metrics Access
Note: Catalog deploys with swagger API documentation. For the most up-to-date fields and complete usage, refer to those docs of your deployment.
In Grey Matter, each is a unique . Catalog provides the ability to track multiple zones, gather high-level information on service statuses, and present them to applications.
A sample zone is shown below. This zone is owned by Decipher, for core and demo capabilities. It has 7 different (4 stable, 2 warning, and 1 down) with a total of 9 unique service instances.
Name
Type
Default
Description
clusterName
String
""
The name of the cluster (logical group name of service instances), provided by gm-control.
zoneName
String
""
The zone in which this service cluster resides.
name
String
""
The name of the service to be displayed in the Intelligence 360 Dashboard (make this as human friendly as possible).
version
String
""
The semver version of the service.
owner
String
""
The name of the service owner like "Decipher" or "Cool Customer". Used to sort by Owner in the Intelligence 360 Dashboard.
capability
String
""
The name of the service capability like "Storage" or "Security". Used to sort by Capability in the Intelligence 360 Dashboard.
documentation
String
""
A URL path to documentation relative to the root URL of the service or a full path depending on your needs.
prometheusJob
String
""
The name of the Prometheus Job used to store and query time series data associated with this service. This must match the cluster name.
minInstances
Number
1
The minimum number of instances this service should scale to. If below this number, the service will be in a warning state in the Intelligence 360 Dashboard.
maxInstances
Number
1
The maximum number of instances this service should scale to. If above this number, the service will be in a warning state in the Intelligence 360 Dashboard.
enableInstanceMetrics
Boolean
true
Enable the instance metrics view in the Intelligence 360 Dashboard.
enableHistoricalMetrics
Boolean
false
Enable the historical metrics view in the Intelligence 360 Dashboard.
metricsTemplate
String
""
URL template for constructing the service's instance metrics endpoint e.g. http://{{host}}:{{port}}/metrics.
metricsPort
Number
8081
TCP port serving up service instance metrics.
Catalog also serves as a normalized passthrough to the real-time metrics for each service. These can be requested with the catalog /metrics endpoint (e.g curl host:port/metrics/<cluster_name>/<instance_id>). See the deployed swagger docs for more detail.
Within each zone, Catalog also tracks each in the Fabric service mesh. Catalog watches the mesh for instances of these services, reports when they're up/down, and presents user-settable metadata for each.