/** * This package defines the internal diagnostics tools for the SharePoint Framework, * including monitoring, trace, user engagement and performance logging. * * @packagedocumentation */ import type { ILogHandler } from '@microsoft/sp-core-library'; import { ServiceKey } from '@microsoft/sp-core-library'; import type { ServiceScope } from '@microsoft/sp-core-library'; import type { _VetoValues } from '@microsoft/sp-core-library'; /* Excluded from this release type: _AutoAlertableMonitorType */ /* Excluded from this release type: _AutoAlertableQosMonitor */ /* Excluded from this release type: _CircularBuffer */ /* Excluded from this release type: _Component */ /* Excluded from this release type: _CurrentPage */ /* Excluded from this release type: _Diagnostics */ /* Excluded from this release type: _EngagementLogger */ /* Excluded from this release type: _ExecutionQueue */ /* Excluded from this release type: _Feature */ /* Excluded from this release type: _IABExperiment */ /* Excluded from this release type: _IClearSettingsOptions */ /* Excluded from this release type: _ICustomerPromiseErrorDetails */ /* Excluded from this release type: _IDiagnosticContextInfo */ /* Excluded from this release type: _IDiagnosticsSettings */ /* Excluded from this release type: _IEngagementData */ /* Excluded from this release type: _IEngagementHandler */ declare interface IExtraData { [key: string]: {} | string | number | boolean | null | undefined; } /* Excluded from this release type: _IExtraDataForCustomerPromise */ /* Excluded from this release type: _IExtraDiagnosticInfo */ /* Excluded from this release type: _ILogData */ /* Excluded from this release type: _ILogEntry */ /* Excluded from this release type: _ILogErrorData */ /* Excluded from this release type: ILogHandler */ /* Excluded from this release type: _ILogSource */ /* Excluded from this release type: _ILogVerboseData */ /** * @public * Privacy data wrapper for telemetry data. */ declare interface IPrivacyData { /** The actual value */ _value: T; /** The type of privacy data */ _type: IPrivacyDataType; } /** * @public * Privacy data type. * safe: The data is safe to log. * unsafe: The data is not safe to log and should be scrubbed or dropped. */ declare type IPrivacyDataType = 'safe' | 'unsafe'; /* Excluded from this release type: _IQos */ /** * @public */ declare interface IQosEndSchema { /** * This is the name of the qos event */ name?: string; /** * This is a endTime override for the qos event */ endTimeOverride?: number; /** * This is result code for the qos event */ resultCode?: string; /** * This is the result type enum */ resultType: ResultTypeEnum; /** * This is the error message to be logged with failed result */ error?: string | IPrivacyData; /** * An optional stack trace to be logged with the error */ stackTrace?: IPrivacyData; /** * This is the random extra data for the qos event */ extraData?: IExtraData; /** * Extra data for the qos event that should be logged as aggregatable metrics */ extraMetrics?: IExtraData; /** * The object type against which the event was invoked. * e.g. 'File', 'Folder', 'List', etc. */ objectType?: ObjectTypeValues; } /* Excluded from this release type: _IQosExtraData */ /* Excluded from this release type: _IQosStartEvent */ /* Excluded from this release type: _ITraceHandler */ /* Excluded from this release type: _ITraceLogEvent */ /* Excluded from this release type: _ITraceLogger */ /* Excluded from this release type: _IVerboseTraceLogEvent */ /* Excluded from this release type: _LogEntry */ /* Excluded from this release type: _LogEvent */ /* Excluded from this release type: _LogFeature */ /* Excluded from this release type: _LogHandler */ /* Excluded from this release type: _LogLevel */ /* Excluded from this release type: _LogManager */ /* Excluded from this release type: _LogSource */ /* Excluded from this release type: _logSourceServiceKey */ /* Excluded from this release type: _LogType */ declare const ObjectTypes: { readonly NPSRating1: 1; readonly NPSRating2: 1; readonly NPSRating3: 1; readonly NPSRating4: 1; readonly NPSRating5: 1; readonly Recent: 1; readonly Site: 1; readonly spJoinedTeam: 1; readonly MyOrganizationAssets: 1; readonly MyLists: 1; readonly RecentLists: 1; readonly DocsInCommon: 1; readonly Channel: 1; readonly OtherUserFiles: 1; readonly ListItem: 1; readonly Libraries: 1; readonly File: 1; readonly Files: 1; readonly MobileDevice: 1; readonly AllPhotos: 1; readonly 'CloudStorage-undefined': 1; readonly 'CloudStorage-BOX': 1; readonly 'CloudStorage-DROPBOX': 1; readonly 'CloudStorage-EGNYTE': 1; readonly 'CloudStorage-GOOGLEDRIVE': 1; readonly 'CloudStorage-SHAREFILE': 1; readonly 'CloudStorage-SharePoint': 1; readonly Downloads: 1; readonly PhoneLink: 1; readonly Shared: 1; readonly SuggestedSite: 1; readonly PhotoStream: 1; readonly LargestFiles: 1; readonly StockImages: 1; readonly BingSearch: 1; readonly Local: 1; readonly Link: 1; readonly custom: 1; readonly outOfBox: 1; readonly Links: 1; readonly FromALink: 1; readonly 'Sharing.getAuthToken': 1; readonly Computed: 1; readonly LinkTitle: 1; readonly Text: 1; readonly Number: 1; readonly Currency: 1; readonly Boolean: 1; readonly URL: 1; readonly Lookup: 1; readonly LookupMulti: 1; readonly MultiLine: 1; readonly RTE: 1; readonly Choice: 1; readonly MultiChoice: 1; readonly User: 1; readonly UserMulti: 1; readonly DateTime: 1; readonly Thumbnail: 1; readonly MMD: 1; readonly Location: 1; readonly Default: 1; readonly Unknown: 1; readonly Home: 1; readonly MyFiles: 1; readonly SharedWithMe: 1; readonly SharedByMe: 1; readonly Favorites: 1; readonly RecycleBin: 1; readonly People: 1; readonly PeopleL2: 1; readonly PeopleL2Folder: 1; readonly PeopleL2LegacyFolder: 1; readonly MountedFolder: 1; readonly MountedLegacyFolder: 1; readonly Meetings: 1; readonly MeetingsL2: 1; readonly DocumentLibrary: 1; readonly AllSites: 1; readonly Folder: 1; readonly LegacyFolder: 1; readonly List: 1; readonly Search: 1; readonly '3rdPartyApp': 1; }; declare type ObjectTypeValues = keyof typeof ObjectTypes; /* Excluded from this release type: _PageType */ /* Excluded from this release type: _PromotedState */ /* Excluded from this release type: _QosLogger */ /* Excluded from this release type: _QosMonitor */ /* Excluded from this release type: _QosMonitorShareFailureWithCP */ /* Excluded from this release type: _QosResultType */ /** * @public */ declare enum ResultTypeEnum { Success = 0, Failure = 1, ExpectedFailure = 2 } /* Excluded from this release type: _SiteType */ /* Excluded from this release type: _TraceLogger */ /* Excluded from this release type: _UsageType */ export { }