mirror of
https://github.com/rstudio/shiny.git
synced 2026-01-11 16:08:19 -05:00
Update NEWS.md
This commit is contained in:
Barret Schloerke
93
NEWS.md
93
NEWS.md
@@ -1,53 +1,98 @@
|
||||
# shiny (development version)
|
||||
|
||||
## OpenTelemetry support (#4269)
|
||||
## OpenTelemetry support
|
||||
|
||||
* Added support for [OpenTelemetry](https://opentelemetry.io/) via [`{otel}`](https://otel.r-lib.org/index.html). By default, if `otel::is_tracing_enabled()` returns `TRUE`, then `{shiny}` will record all OpenTelemetery spans. See [`{otelsdk}`'s Collecting Telemetry Data](https://otelsdk.r-lib.org/reference/collecting.html) for more details on configuring OpenTelemetry.
|
||||
* Shiny now supports [OpenTelemetry](https://opentelemetry.io/) via
|
||||
[`{otel}`](https://otel.r-lib.org/index.html). By default, if
|
||||
`otel::is_tracing_enabled()` returns `TRUE`, then `{shiny}` records all
|
||||
OpenTelemetry spans. See [`{otelsdk}`'s Collecting Telemetry
|
||||
Data](https://otelsdk.r-lib.org/reference/collecting.html) for more details
|
||||
on configuring OpenTelemetry. (#4269, #4300)
|
||||
|
||||
* Supported values for `options(shiny.otel.bind)` (or `Sys.getenv("SHINY_OTEL_BIND")`):
|
||||
* Supported values for `options(shiny.otel.bind)` (which defaults to
|
||||
`Sys.getenv("SHINY_OTEL_BIND")` if set) are:
|
||||
* `"none"` - No Shiny OpenTelemetry tracing.
|
||||
* `"session"` - Adds session start/end spans.
|
||||
* `"reactive_update"` - Spans for any synchronous/asynchronous reactive update. (Includes `"session"` features).
|
||||
* `"reactivity"` - Spans for all reactive expressions. (Includes `"reactive_update"` features).
|
||||
* `"all"` [default] - All Shiny OpenTelemetry tracing. Currently equivalent to `"reactivity"`.
|
||||
* `"reactive_update"` - Spans for any synchronous/asynchronous reactive
|
||||
update. (Includes `"session"` features).
|
||||
* `"reactivity"` - Spans for all reactive expressions. (Includes
|
||||
`"reactive_update"` features).
|
||||
* `"all"` [default] - All Shiny OpenTelemetry tracing. Currently equivalent
|
||||
to `"reactivity"`.
|
||||
|
||||
* Spans are recorded for:
|
||||
* `session_start`: Wraps the calling of the `server()` function. Also contains HTTP request within the attributes.
|
||||
* OpenTelemetry spans are recorded for:
|
||||
* `session_start`: Wraps the calling of the `server()` function. Also
|
||||
contains HTTP request within the attributes.
|
||||
* `session_end`: Wraps the calling of the `onSessionEnded()` handlers.
|
||||
* `reactive_update`: Signals the start of when Shiny knows something is to be calculated. This span ends when there are no more reactive updates (promises or synchronous) to be calculated.
|
||||
* `reactive`, `observe`, `output`: Captures the calculation (including any async promise chains) of a reactive expression (`reactive()`), an observer (`observe()`), or an output render function (`render*()`).
|
||||
* `reactive debounce`, `reactive throttle`: Captures the calculation (including any async promise chains) of a `debounce()`d or `throttle()`d reactive expression.
|
||||
* `ExtendedTask`: Captures the calculation (including any async promise chains) of an `ExtendedTask`.
|
||||
* `reactive_update`: Signals the start of when Shiny knows something is to
|
||||
be calculated. This span ends when there are no more reactive updates
|
||||
(promises or synchronous) to be calculated.
|
||||
* `reactive`, `observe`, `output`: Captures the calculation (including any
|
||||
async promise chains) of a reactive expression (`reactive()`), an observer
|
||||
(`observe()`), or an output render function (`render*()`).
|
||||
* `reactive debounce`, `reactive throttle`: Captures the calculation
|
||||
(including any async promise chains) of a `debounce()`d or `throttle()`d
|
||||
reactive expression.
|
||||
* `reactiveFileReader`, `reactivePoll`: Captures the calculation
|
||||
(including any async promise chains) of a `reactiveFileReader()` or
|
||||
`reactivePoll()`.
|
||||
* `ExtendedTask`: Captures the calculation (including any async promise
|
||||
chains) of an `ExtendedTask`.
|
||||
|
||||
* OpenTelemetry Logs are recorded for:
|
||||
* `Set reactiveVal <name>` - When a `reactiveVal()` is set
|
||||
* `Set reactiveValues <name>$<key>` - When a `reactiveValues()` element is set
|
||||
* Fatal or unhandled errors - When an error occurs that causes the session to end, or when an unhandled error occurs in a reactive context. Contains the error within the attributes. To unsantize the error message being collected, set `options(shiny.otel.sanitize.errors = FALSE)`.
|
||||
* `Set ExtendedTask <name> <value>` - When an `ExtendedTask`'s respective reactive value (e.g., `status`, `value`, and `error`) is set.
|
||||
* `<ExtendedTask name> add to queue` - When an `ExtendedTask` is added to the task queue.
|
||||
* `Set reactiveValues <name>$<key>` - When a `reactiveValues()` element is
|
||||
set
|
||||
* Fatal or unhandled errors - When an error occurs that causes the session
|
||||
to end, or when an unhandled error occurs in a reactive context. Contains
|
||||
the error within the attributes. To unsanitize the error message being
|
||||
collected, set `options(shiny.otel.sanitize.errors = FALSE)`.
|
||||
* `Set ExtendedTask <name> <value>` - When an `ExtendedTask`'s respective
|
||||
reactive value (e.g., `status`, `value`, and `error`) is set.
|
||||
* `<ExtendedTask name> add to queue` - When an `ExtendedTask` is added to
|
||||
the task queue.
|
||||
|
||||
* All logs and spans contain the `session.id` attribute.
|
||||
* All OpenTelemetry logs and spans will contain a `session.id` attribute
|
||||
containing the active session ID.
|
||||
|
||||
## New features
|
||||
|
||||
* The `icon` argument of `updateActionButton()`/`updateActionLink()` nows allows values other than `shiny::icon()` (e.g., `fontawesome::fa()`, `bsicons::bs_icon()`, etc). (#4249)
|
||||
* `updateActionButton()` and `updateActionLink()` now accept values other than
|
||||
`shiny::icon()` for the `icon` argument (e.g., `fontawesome::fa()`,
|
||||
`bsicons::bs_icon()`, etc). (#4249)
|
||||
|
||||
## Bug fixes
|
||||
## Bug fixes and minor improvements
|
||||
|
||||
* `updateActionButton()`/`updateActionLink()` now correctly renders HTML content passed to the `label` argument. (#4249)
|
||||
* Showcase mode now uses server-side markdown rendering with the
|
||||
`{commonmark}` package, providing support for GitHub Flavored Markdown
|
||||
features (tables, strikethrough, autolinks, task lists). While most existing
|
||||
README.md files should continue to work as expected, some minor rendering
|
||||
differences may occur due to the change in markdown processor. (#4202,
|
||||
#4201)
|
||||
|
||||
* Fixed an issue where `updateSelectizeInput(options = list(plugins="remove_button"))` could lead to multiple remove buttons. (#4275)
|
||||
* `debounce()`, `reactiveFileReader()`, `reactivePoll()`, `reactiveValues()`,
|
||||
and `throttle()` now attempt to retrieve the assigned name for the default
|
||||
label if the srcref is available. If a value cannot easily be produced, a
|
||||
default label is used instead. (#4269, #4300)
|
||||
|
||||
* The default label for items described below will now attempt to retrieve the assigned name if the srcref is available. If a value can not easily be produced, a default label will be used instead. This should improve the OpenTelemetry span labels and the reactlog experience. (#4269, #4300)
|
||||
* `reactiveValues()`, `reactivePoll()`, `reactiveFileReader()`, `debounce()`, `throttle()`, `observe()`
|
||||
* Combinations of `bindEvent()` and `reactive()` / `observe()`
|
||||
* Combination of `bindCache()` and `reactive()`
|
||||
|
||||
## Changes
|
||||
* `updateActionButton()` and `updateActionLink()` now correctly render HTML
|
||||
content passed to the `label` argument. (#4249)
|
||||
|
||||
* Markdown rendering in showcase mode now uses server-side rendering with the `{commonmark}` package, providing support for GitHub Flavored Markdown features (tables, strikethrough, autolinks, task lists). While most existing README.md files should continue to work as expected, some minor rendering differences may occur due to the change in markdown processor. (#4202, #4201)
|
||||
* `updateSelectizeInput()` no longer creates multiple remove buttons when
|
||||
`options = list(plugins="remove_button")` is used. (#4275)
|
||||
|
||||
* The return value of `actionButton()`/`actionLink()` changed slightly: `label` and `icon` are wrapped in an additional HTML container element. This allows for: 1. `updateActionButton()`/`updateActionLink()` to distinguish between the `label` and `icon` when making updates and 2. spacing between `label` and `icon` to be more easily customized via CSS.
|
||||
## Breaking changes
|
||||
|
||||
* The return value of `actionButton()` and `actionLink()` now wraps `label`
|
||||
and `icon` in an additional HTML container element. This allows
|
||||
`updateActionButton()` and `updateActionLink()` to distinguish between the
|
||||
`label` and `icon` when making updates, and allows spacing between `label`
|
||||
and `icon` to be more easily customized via CSS.
|
||||
|
||||
# shiny 1.11.1
|
||||
|
||||
|
||||
Reference in New Issue
Block a user