A very core part of cState is the components you have on your status page. They are defined much like custom tabs and can be changed from your site’s config.yml file.
Each component has several possible values, all are caps and space sensitive:
- name: Backup Media Proxy
displayName: Media Proxy
category: Backup Systems
description: This is the service responsible for serving images, audio, and video. It is reliant on Fastly.
link: https://example.com
partial: custom/metricsname. This is the name of the component. (required)
displayName. Added in v4.1. If you have components with similar names under multiple categories, you may wish to display API for two separate categories instead of API A and API B. This is purely cosmetic — it changes the name of the system on the home page. Learn more
category. This is what category the component belongs to. You only need to define the name. Again, caps and space sensitive. More information about categories down below. This is required, starting with version 4. You can simply add “Uncategorized”, if you so wish.
description. If the name of the component can cause some confusion, or you just want to provide extra information, you can add a description, which will be shown once a user hovers over the question mark icon.
link: Added in v5.3. If present, this will display a clickable button leading to the specified url. In case the component has/is a frontend and you wish to link to it.
partial. If you wish to add custom HTML to the component, you can define a partial name & location, which will be used for that component.