@sentry/hub
Advanced tools
Package description
The @sentry/hub package is part of the Sentry SDK for JavaScript. It is responsible for managing scopes, breadcrumbs, and client instances. It allows for the isolation of data through the use of multiple hubs and scopes, which is useful in complex applications where different parts of the application might need to report different pieces of context or breadcrumbs.
Managing Scopes
This feature allows you to manage scopes, which are used to hold contextual data such as tags, extra information, and breadcrumbs. You can push and pop scopes to control the context data that is sent with events.
{"const { Hub, Scope } = require('@sentry/hub');
const hub = new Hub();
const scope = new Scope();
scope.setExtra('user_id', '12345');
hub.pushScope(scope);
// Perform operations within this scope
hub.popScope(); // Revert to the previous scope"}Managing Breadcrumbs
Breadcrumbs are a way to record events that happened prior to an issue. This feature allows you to add breadcrumbs to the current scope, which can then be sent along with error reports to help diagnose issues.
{"const { Hub } = require('@sentry/hub');
const hub = new Hub();
hub.addBreadcrumb({
message: 'User clicked a button',
category: 'user-interaction',
level: 'info'
});
// This breadcrumb will be attached to the next captured event"}Isolating Clients
This feature allows you to create isolated instances of Sentry clients. Each client can have its own configuration and integrations, and you can use multiple clients within the same application for different purposes.
{"const { Hub, Integrations } = require('@sentry/hub');
const Sentry = require('@sentry/node');
const client = new Sentry.NodeClient({
dsn: 'your dsn',
integrations: [new Integrations.Http({ tracing: true })]
});
const hub = new Hub(client);
// You can now use this hub to capture events and manage scopes with the associated client"}Winston is a multi-transport async logging library for Node.js. While it is not a direct alternative to @sentry/hub, it provides similar functionality in terms of logging and managing contextual information. Unlike @sentry/hub, winston focuses on general-purpose logging and does not specialize in error tracking and reporting.
Bunyan is a simple and fast JSON logging library for Node.js services. Like winston, it is more focused on logging rather than error tracking. It does not have the concept of scopes and hubs but provides a way to log structured data and create child loggers with bound contextual information.
Pino is a very low overhead Node.js logger. It provides similar logging capabilities to winston and bunyan but emphasizes performance. Pino does not have the advanced error tracking and context management features of @sentry/hub but is a good choice for applications where performance is critical.
Changelog
7.100.0
This release includes some deprecations. For more details please look at our migration guide.
The deprecation most likely to affect you is the one of BrowserTracing. Instead of new BrowserTracing(), you should
now use browserTracingIntegration(), which will also handle framework-specific instrumentation out of the box for
you - no need to pass a custom routingInstrumentation anymore. For @sentry/react, we expose dedicated integrations
for the different react-router versions:
reactRouterV6BrowserTracingIntegration()reactRouterV5BrowserTracingIntegration()reactRouterV4BrowserTracingIntegration()reactRouterV3BrowserTracingIntegration()See the migration guide for details.
browserTracingIntegration() (#10353)BrowserTracing integration (#10493)browserProfilingIntegration (#10438)bunServerIntegration() (#10439)browserTracingIntegration (#10397)reactRouterV3BrowserTracingIntegration for react router v3 (#10489)reactRouterV4/V5BrowserTracingIntegration for react router v4 & v5 (#10488)reactRouterV6BrowserTracingIntegration for react router v6 & v6.4 (#10491)browserTracingIntegration (#10442)WinterCGFetch with winterCGFetchIntegration (#10436)continueTrace (#10301)new VueIntegration() (#10440)browserTracingIntegration() (#10477)browserTracingIntegration() (#10450)@sentry/profiling-node has been ported into the monorepo. Future development for it will happen here!
setHttpStatus from all packages (#10475)Sentry namespace (#10452)name & attributes to tracesSampler (#10426)system-ui to start of font family (#10464)rrweb to 2.10.0 (#10445)propagationContextFromHeaders (#10313)startSpan, startSpanManual and startInactiveSpan pick up the scopes at time of creation instead of
termination (#10492)require call to import Undici (#10388)Readme
This package provides the Hub and Scope for all JavaScript related SDKs.
FAQs
Sentry hub which handles global state managment.
We found that @sentry/hub demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.