Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a section for scalar vs. timeseries in wildcard widget #26324

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions content/en/dashboards/widgets/wildcard.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
1. [Check native widgets][4]. See if a Datadog widget can fulfill your requirements.
1. If no Datadog widget meets your requirements, in a new or pre-existing dashboard, click **Add Widgets**.
1. Click and drag the Wildcard Widget icon from the widget tray.
1. Select from the **Request Type** dropdown. For more information on Scalar and Timeseries types, see the [Formulas Scalar vs. Formulas Timeseries] section of this page.
estherk15 marked this conversation as resolved.
Show resolved Hide resolved
1. Copy a Vega-Lite Definition from the [public gallery][5] to find a starter Vega-Lite specification.
1. Open the Wildcard widget [full screen editor][6] and click **Define Visual**.
1. Paste the copied Vega-Lite definition.
Expand All @@ -41,6 +42,22 @@
1. (Optional) Debug Vega-Lite specification mismatches with [Data Preview](#data-preview). Make sure the query in your Vega-Lite specification maps to the Datadog query.
1. Click **Save**.

#### Formulas Scalar vs. Formulas Timeseries

Check warning on line 45 in content/en/dashboards/widgets/wildcard.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.headings

'Formulas Scalar vs. Formulas Timeseries' should use sentence-style capitalization.

In Datadog dashboards, scalar and timeseries visualizations serve different purposes and are used to represent data in distinct ways.

Check notice on line 47 in content/en/dashboards/widgets/wildcard.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.oxfordcomma

Suggestion: Use the Oxford comma in 'In Datadog dashboards, scalar and'.

**Timeseries**
: This visualization is designed to display how your data changes over time.
- **Use-cases**: It's ideal for monitoring metrics that fluctuate, such as CPU usage, memory consumption, or request rates. It helps identify trends, patterns, and anomalies over a specified time range.
- **Appearance**: These visualizations are typically line or area charts. They show data points plotted against time (usually on the x-axis), making it easy to observe changes and trends.

Check warning on line 52 in content/en/dashboards/widgets/wildcard.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.words

Use 'datapoints' instead of 'data points'.

Check warning on line 52 in content/en/dashboards/widgets/wildcard.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.words

Use '' instead of 'easy'.
estherk15 marked this conversation as resolved.
Show resolved Hide resolved

**Scalar**
: This visualization presents a single, aggregate value derived from your data.
- **Use-cases**: It's best for displaying key performance indicators (KPIs) or summary statistics such as averages, sums, or percentiles. It provides a summary view of the current state or a specific metric.
- **Appearance**: Scalars often appear as large, standalone numbers or small cards on dashboards, highlighting the most relevant statistics, like the current number of active users, or the sum of errors over the last hour.

Timeseries visualizations emphasize data trends over time, scalar visualizations focus on presenting single, computed values that help with quick assessments. If you're going to visualize time on an axis, or need individual time buckets, choose the Timeseries type. However, if you're not vizualizing against time, choose the Scalar type as it's much more performant.

Check warning on line 59 in content/en/dashboards/widgets/wildcard.md

View workflow job for this annotation

GitHub Actions / vale

Datadog.words

Use '' instead of 'quick'.

### Import data from an existing widget

1. Copy from an existing Datadog widget using `cmd+c`.
Expand Down
Loading