This submit is about Dashify, the Cisco Observability Platform’s dashboarding framework. We’re going to describe how AppDynamics, and companions, use Dashify to construct customized product screens, after which we’re going to dive into particulars of the framework itself. We’ll describe its particular options that make it essentially the most highly effective and versatile dashboard framework within the business.

What are dashboards?

Dashboards are data-driven person interfaces which might be designed to be seen, edited, and even created by product customers. Product screens themselves are additionally constructed with dashboards. For that reason, a whole dashboard framework gives leverage for each the tip customers seeking to share dashboards with their groups, and the product-engineers of COP options like Cisco Cloud Observability.

Within the observability house most dashboards are targeted on charts and tables for rendering time collection knowledge, for instance “common response time” or “errors per minute”. The picture beneath exhibits the COP EBS Volumes Overview Dashboard, which is used to grasp the efficiency of Elastic Block Storage (EBS) on Amazon Net Providers. The dashboard options interactive controls (dropdowns) which might be used to further-refine the situation from all EBS volumes to, for instance unhealthy EBS volumes in US-WEST-1.

A number of different dashboards are supplied by our Cisco Cloud Observability app for monitoring different AWS methods. Listed below are just some examples of the quickly increasing use of Dashify dashboards throughout the Cisco Observability Platform.

• EFS Volumes
• Elastic Load Balancers
• S3 Buckets
• EC2 Cases

Why Dashboards

No observability product can “pre-imagine” each means that clients need to observe their methods. Dashboards permit end-users to create customized experiences, constructing on current in-product dashboards, or creating them from scratch. I’ve seen massive organizations with greater than 10,000 dashboards throughout dozens of groups.

Dashboards are a cornerstone of observability, forming a bridge between a distant knowledge supply, and native show of knowledge within the person’s browser. Dashboards are used to seize “eventualities” or “lenses” on a selected drawback. They will serve a comparatively fastened use case, or they are often ad-hoc creations for a troubleshooting “struggle room.” A dashboard performs many steps and queries to derive the information wanted to handle the observability situation, and to render the information into visualizations. Dashboards may be authored as soon as, and utilized by many alternative customers, leveraging the know-how of the creator to enlighten the viewers. Dashboards play a vital position in low-level troubleshooting and in rolling up high-level enterprise KPIs to executives.

The aim of dashboard frameworks has at all times been to supply a means for customers, versus ‘builders’, to construct helpful visualizations. Inherent to this “democratization” of visualizations is the notion that constructing a dashboard should by some means be simpler than a pure JavaScript app improvement strategy. Afterall, dashboards cater to customers, not hardcore builders.

The issue with dashboard frameworks

The diagram beneath illustrates how a standard dashboard framework permits the creator to configure and organize elements however doesn’t permit the creator to create new elements or knowledge sources. The dashboard creator is caught with no matter elements, layouts, and knowledge sources are made obtainable. It’s because the areas proven in purple are developed in JavaScript and are supplied by the framework. JavaScript is neither a safe, nor simple expertise to be taught, subsequently it’s hardly ever uncovered on to authors. As a substitute, dashboards expose a JSON or YAML based mostly DSL. This usually leaves discipline groups, SEs, and energy customers within the place of ready for the engineering group to launch new elements, and there may be virtually at all times a deep function backlog.

I’ve personally seen this situation play out many instances. To take an actual instance, a group constructing dashboards for IT providers needed rows in a desk to be coloured in line with a “warmth map”. This required a function request to be logged with engineering, and the core JavaScript-based Desk part needed to be modified to assist warmth maps. It turned typical for the core JS elements to grow to be a mishmash of domain-driven spaghetti code. Finally the code for Desk itself was laborious to seek out amidst the handfuls of props and hidden behaviors like “warmth maps”. No person was pleased with the state of affairs, but it surely was typical, and core part groups largely spent their dash cycles constructing area behaviors and attempting to grasp the spaghetti. What if dashboard authors themselves on the power-user finish of the spectrum may very well be empowered to create elements themselves?

Enter Dashify

Dashify’s mission is to take away the barrier of “you may’t try this” and “we don’t have a part for that”. To perform this, Dashify rethinks among the foundations of conventional dashboard frameworks. The diagram beneath exhibits that Dashify shifts the boundaries round what’s “inbuilt” and what’s made utterly accessible to the Creator. This radical shift permits the core framework group to concentrate on “pure” visualizations, and empowers area groups, who creator dashboards, to construct area particular behaviors like “IT warmth maps” with out being blocked by the framework group.

To perform this breakthrough, Dashify needed to remedy the important thing problem of the best way to simplify and expose reactive conduct and composition with out cracking open the proverbial can of JavaScript worms. To do that, Dashify leveraged a brand new JSON/YAML meta-language, created at Cisco within the open supply, for the aim of declarative, reactive state administration. This new meta-language known as “Said,” and it’s getting used to drive dashboards, in addition to many different JSON/YAML configurations throughout the Cisco Observability Platform. Let’s take a easy instance to indicate how Said allows a dashboard creator to insert logic instantly right into a dashboard JSON/YAML.

Suppose we obtain knowledge from a knowledge supply that gives “well being” about AWS availability zones. Assume the well being knowledge is up to date asynchronously. Now suppose we want to bind the altering well being knowledge to a desk of “alerts” in line with some enterprise guidelines:

1. solely present alerts if the proportion of unhealthy situations is bigger than 10%
2. present alerts in descending order based mostly on proportion of unhealthy situations
3. replace the alerts each time the well being knowledge is up to date (in different phrases declare a reactive dependency between alerts and well being).

This snippet illustrates a desired state, that adheres to the principles.

However how can we construct a dashboard that constantly adheres to the three guidelines? If the well being knowledge modifications, how can we be certain the alerts will likely be up to date? These questions get to the center of what it means for a system to be Reactive. This Reactive situation is at finest troublesome to perform in immediately’s well-liked dashboard frameworks.

Discover we’ve got framed this drawback when it comes to the information and relationships between totally different knowledge objects (well being and alerts), with out mentioning the person interface but. Within the diagram above, be aware the “knowledge manipulation” layer. This layer permits us to create precisely these sorts of reactive (change pushed) relationships between knowledge, decoupling the information from the visible elements.

Let’s take a look at how simple it’s in Dashify to create a reactive knowledge rule that captures our three necessities. Dashify permits us to interchange *any* piece of a dashboard with a reactive rule, so we merely write a reactive rule that generates the alerts from the well being. The Said rule, starting on line 12 is a JSONata expression. Be happy to attempt it your self right here.

One of the fascinating issues is that it seems you don’t need to “inform” Dashify what knowledge your rule relies on. You simply write your rule. This simplicity is enabled by Said’s compiler, which analyzes all the principles within the template and produces a Reactive change graph. When you change something that the ‘alerts’ rule is taking a look at, the ‘alerts’ rule will fireplace, and recompute the alerts. Let’s rapidly show this out utilizing the said REPL which lets us run and work together with Said templates like Dashify dashboards. Let’s see what occurs if we use Said to vary the primary zone’s unhealthy rely to 200. The screenshot beneath exhibits execution of the command “.set /well being/0/unhealthy 200” within the Said JSON/YAML REPL. Dissecting this command, it says “set the worth at json pointer /well being/0/unhealthy to worth 200”. We see that the alerts are instantly recomputed, and that us-east-1a is now current within the alerts with 99% unhealthy.

By recasting a lot of dashboarding as a reactive knowledge drawback, and by offering a strong in-dashboard expression language, Dashify permits authors to do each conventional dashboard creation, superior knowledge bindings, and reusable part creation. Though fairly trivial, this instance clearly exhibits how Dashify differentiates its core expertise from different frameworks that lack reactive, declarative, knowledge bindings. Actually, Dashify is the primary, and solely framework to function declarative, reactive, knowledge bindings.

Let’s take one other instance, this time fetching knowledge from a distant API. Let’s say we need to fetch knowledge from the Star Wars REST api. Enterprise necessities:

1. Developer can set what number of pages of planets to return
2. Planet particulars are fetched from star wars api (https://swapi.dev)
3. Record of planet names is extracted from returned planet particulars
4. Person ought to have the ability to choose a planet from the checklist of planets
5.  ‘residents’ URLs are extracted from planet data (that we acquired in step 2), and resident particulars are fetched for every URL
6. Full names of inhabitants are extracted from resident particulars and offered as checklist

Once more, we see that earlier than we even think about the person interface, we are able to forged this drawback as a knowledge fetching and reactive binding drawback. The dashboard snippet beneath exhibits how a price like “residents” is reactively sure to selectedPlanet and the way map/scale back model set operators are utilized to whole outcomes of a REST question. Once more, all of the expressions are written within the grammar of JSONata.

To exhibit how one can work together with and check such a snippet, checkout This github gist exhibits a REPL session the place we:

1. load the JSON file and observe the default output for Tatooine
2. Show the reactive change-plan for planetName
3. Set the planet title to “Coruscant”
4. Name the onSelect() perform with “Naboo” (this demonstrates that we are able to create features accessible from JavaScript, to be used as click on handlers, however produces the identical outcome as instantly setting planetName)

From this concise instance, we are able to see that dashboard authors can simply deal with fetching knowledge from distant APIs, and carry out extractions and transformations, in addition to set up click on handlers. All these artifacts may be examined from the Said REPL earlier than we load them right into a dashboard. This exceptional economic system of code and ease of improvement can’t be achieved with another dashboard framework.
In case you are curious, these are the inhabitants of Naboo:

What’s subsequent?

We have now proven quite a lot of “knowledge code” on this submit. This isn’t meant to suggest that constructing Dashify dashboards requires “coding”. Slightly, it’s to indicate that the foundational layer, which helps our Dashboard constructing GUIs is constructed on very strong basis. Dashify not too long ago made its debut within the CCO product with the introduction of AWS monitoring dashboards, and Information Safety Posture Administration screens. Dashify dashboards at the moment are a core part of the Cisco Observability Platform and have been confirmed out over many advanced use instances. In calendar Q2 2024, COP will introduce the dashboard modifying expertise which gives authors with inbuilt visible drag-n-drop model modifying of dashboards. Additionally in calendar Q2, COP introduces the power to bundle dashify dashboards into COP options permitting third get together builders to unleash their dashboarding abilities. So, climate you skew to the “give me a gui” finish of the spectrum or the “let me code” life-style, Dashify is designed to fulfill your wants.

Summing it up

Dashboards are a key, maybe THE key expertise in an observability platform. Present dashboarding frameworks current unwelcome limits on what authors can do. Dashify is a brand new dashboarding framework born from many collective years of expertise constructing each dashboard frameworks and their visible elements. Dashify brings declarative, reactive state administration into the palms of dashboard authors by incorporating the Said meta-language into the JSON and YAML of dashboards. By rethinking the basics of knowledge administration within the person interface, Dashify permits authors unprecedented freedom. Utilizing Dashify, area groups can ship advanced elements and behaviors with out getting slowed down within the underlying JavaScript frameworks. Keep tuned for extra posts the place we dig into the thrilling capabilities of Dashify: Customized Dashboard Editor, Widget Playground, and Scalable Vector Graphics.

Associated sources

Share: