updated example and readme

Author: martinkuba

examples/opentelemetry-web/examples/session/index.js

@@ -8,15 +8,14 @@ const {
 const {
  createSessionSpanProcessor,
  createSessionLogRecordProcessor,
- Session,
- SessionManager,
- DefaultIdGenerator,
+ createSessionManager,
+ createDefaultSessionIdGenerator,
  LocalStorageSessionStore
 } = require('@opentelemetry/web-common');
 
 // session manager
-const sessionManager = await createSessionManager({
- sessionIdGenerator: new DefaultIdGenerator(),
+const sessionManager = createSessionManager({
+ sessionIdGenerator: createDefaultSessionIdGenerator(),
  sessionStore: new LocalStorageSessionStore(),
  maxDuration: 20,
  inactivityTimeout: 10
@@ -31,19 +30,28 @@ sessionManager.addObserver({
  }
 });
 
+// restore or start session
+sessionManager.start();
+
 // configure tracer
-const provider = new WebTracerProvider();
-provider.addSpanProcessor(createSessionSpanProcessor(sessionManager));
-provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
-provider.register();
-const tracer = provider.getTracer('example');
+const tracerProvider = new WebTracerProvider({
+ spanProcessors: [
+ createSessionSpanProcessor(sessionManager),
+ new SimpleSpanProcessor(new ConsoleSpanExporter())
+ ]
+});
+
+tracerProvider.register();
+const tracer = tracerProvider.getTracer('example');
 
 // configure logger
-const loggerProvider = new LoggerProvider();
-loggerProvider.addLogRecordProcessor(createSessionLogRecordProcessor(sessionManager));
-loggerProvider.addLogRecordProcessor(
- new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())
-);
+const loggerProvider = new LoggerProvider({
+ processors: [
+ createSessionLogRecordProcessor(sessionManager),
+ new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())
+ ]
+});
+
 const logger = loggerProvider.getLogger('example');
 
 window.addEventListener('load', () => {

experimental/packages/web-common/README.md

@@ -30,26 +30,36 @@ Example:
 const {
  createSessionSpanProcessor,
  createSessionLogRecordProcessor,
+ createDefaultSessionIdGenerator,
  SessionManager,
  DefaultIdGenerator,
  LocalStorageSessionStore
 } = require('@opentelemetry/web-common');
 
 // session manager
 const sessionManager = new SessionManager({
- sessionIdGenerator: new DefaultIdGenerator(),
+ sessionIdGenerator: createDefaultSessionIdGenerator(),
  sessionStore: new LocalStorageSessionStore(),
  maxDuration: 7200, // 4 hours
  inactivityTimeout: 1800 // 30 minutes
 });
 
+// restore or start session
+sessionManager.start();
+
 // configure tracer
-const provider = new WebTracerProvider();
-provider.addSpanProcessor(createSessionSpanProcessor(sessionManager));
+const tracerProvider = new WebTracerProvider({
+ spanProcessors: [
+ createSessionSpanProcessor(sessionManager),
+ ]
+});
 
 // configure logger
-const loggerProvider = new LoggerProvider();
-loggerProvider.addLogRecordProcessor(createSessionLogRecordProcessor(sessionManager));
+const loggerProvider = new LoggerProvider({
+ processors: [
+ createSessionLogRecordProcessor(sessionManager),
+ ]
+});
 ```
 
 The above implementation can be customized by providing different implementations of SessionStore and SessionIdGenerator.
@@ -79,16 +89,22 @@ function getSessionId() {
 }
 
 // configure tracer
-const provider = new WebTracerProvider();
-provider.addSpanProcessor(createSessionSpanProcessor({
- getSessionId: getSessionId
-}));
+const tracerProvider = new WebTracerProvider({
+ spanProcessors: [
+ createSessionSpanProcessor({
+ getSessionId: getSessionId
+ }),
+ ]
+});
 
 // configure logger
-const loggerProvider = new LoggerProvider();
-loggerProvider.addLogRecordProcessor(createSessionLogRecordProcessor({
- getSessionId: getSessionId
-}));
+const loggerProvider = new LoggerProvider({
+ processors: [
+ createSessionLogRecordProcessor({
+ getSessionId: getSessionId
+ }),
+ ]
+});
 ```
 
 ## Useful links

experimental/packages/web-common/src/index.ts

@@ -19,6 +19,7 @@ export {
  createSessionSpanProcessor,
  createSessionLogRecordProcessor,
  createSessionManager,
+ createDefaultSessionIdGenerator
 } from './utils';
 export type { Session } from './types/Session';
 export type { SessionIdGenerator } from './types/SessionIdGenerator';

experimental/packages/web-common/src/utils.ts

@@ -35,11 +35,10 @@ export function createSessionLogRecordProcessor(
  return new SessionLogRecordProcessor(sessionProvider);
 }
 
-export async function createSessionManager(
+export function createSessionManager(
  config: SessionManagerConfig
-): Promise<SessionManager> {
+): SessionManager {
  const manager = new SessionManager(config);
- await manager.start();
  return manager;
 }