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.

Sign up for GitHub

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

[FIX]: typos, broken file URL links #62

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[FIX]: typos, broken file URL links #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Destination is an entity which perform log operation according to its implementa
1. [Console (OktaLoggerConsoleLogger)](#console-destination)
2. [File (OktaLoggerFileLogger)](#file-destination)
3. [Firebase (OktaLoggerFirebaseCrashlyticsLogger)](#firebase-crashlytics-destination)
4. [AppCenter (AppCenterLogger)](#app-center-destination)
4. [Instabug (OktaLoggerInstabugLogger)](#instabug-destination)

All of the default logging destinations are thread-safe and could be used from any thread.

Expand All @@ -116,25 +116,25 @@ Each destination also has `defaultProperties` parameter. This is key-value struc

### Console destination

Related class - [OktaLoggerConsoleLogger](OktaLogger/OktaLoggerConsoleLogger.swift).
This destination is using `os_log` function to print log messages to the console. It does not contain any 3rd party dependencies and mainly used during the XCode debug sessions.
Related class - [OktaLoggerConsoleLogger](Sources/OktaLogger/OktaLoggerConsoleLogger.swift).
This destination is using `os_log` function to print log messages to the console. It does not contain any 3rd party dependencies and mainly used during the Xcode debug sessions.

### File destination

Related class - [OktaLoggerFileLogger](OktaLogger/FileLoggers/OktaLoggerFileLogger.swift).
Related class - [OktaLoggerFileLogger](Sources/OktaLogger/FileLoggers/OktaLoggerFileLogger.swift).
The purpose of this destination is storing logs on the disk.
There are several features available:

- Writing logs to filesystem in the specified location;
- Configure amount of logs that should be collected and the rolling policy (see [OktaLoggerFileLoggerConfig](OktaLogger/FileLoggers/OktaLoggerFileLoggerConfig.swift));
- Configure amount of logs that should be collected and the rolling policy (see [OktaLoggerFileLoggerConfig](Sources/OktaLogger/FileLoggers/OktaLoggerFileLoggerConfig.swift));
- Retrieve log data and log files paths;
- Purge existing logs.

File logging destination is using [CocoaLumberjack](https://github.com/CocoaLumberjack/CocoaLumberjack) for logging implementation.

### Firebase Crashlytics destination

Related class - [OktaLoggerFirebaseCrashlyticsLogger](OktaLogger/FirebaseCrashlyticsLogger/OktaLoggerFirebaseCrashlyticsLogger.swift).
Related class - [OktaLoggerFirebaseCrashlyticsLogger](Sources/OktaLogger/FirebaseCrashlyticsLogger/OktaLoggerFirebaseCrashlyticsLogger.swift).
This destination is using FirebaseCrashlytics SDK to log messages, so they can be accessed from Firebase console.
There are few important features and restrictions in this destination:

Expand All @@ -150,7 +150,7 @@ This destination is using [Firebase Crashlytics SDK](https://github.com/firebase
### Instabug destination

Related class -
[OktaLoggerInstabugLogger](OktaLogger/InstabugLogger/OktaLoggerInstabugLogger.swift).
[OktaLoggerInstabugLogger](Sources/OktaLogger/InstabugLogger/OktaLoggerInstabugLogger.swift).
This destination uses the Instabug SDK to send events, so they can be accessed from the Instabug console in bug report or improvement suggestion.
There are a few important features and restrictions in this destination:

Expand All @@ -173,7 +173,7 @@ This destination is using [Instabug iOS SDK](https://github.com/Instabug/Instabu

If you want to create your custom destination it is recommended to inherit it from `OktaLoggerDestinationBase` class, as this class implements some basic functionality. Hovewer, the only requirement for destinations is to conform to `OktaLoggerDestinationProtocol`.

If you choose to inherit from `OktaLoggerDestinationBase`, than you need to implement `log()` method in order to make it work. You can use `stringValue()` method to receive default log message string representation. Please, refer to [OktaLoggerConsoleLogger](OktaLogger/OktaLoggerConsoleLogger.swift) as an example of logger destination implementation.
If you choose to inherit from `OktaLoggerDestinationBase`, than you need to implement `log()` method in order to make it work. You can use `stringValue()` method to receive default log message string representation. Please, refer to [OktaLoggerConsoleLogger](Sources/OktaLogger/OktaLoggerConsoleLogger.swift) as an example of logger destination implementation.

## OktaAnalytics

Expand Down