Uploaded image for project: 'Couchbase Documentation'
  1. Couchbase Documentation
  2. DOC-12400

Annotations on iOS File logging config example are incorrect

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Major
    • Mobile Beryllium
    • Mobile Beryllium
    • couchbase-lite
    • None

    Description

      https://docs.couchbase.com/couchbase-lite/3.2/swift/troubleshooting-logs.html#eg-file-log

      The annotations 2 and 4 are incorrect.
      The code at annotation 2 is setting the log format to plain text, which disables binary logging (binary logging is the default).
      The code at annotation 4 is setting the global LogFileConfiguration to use the config just created, which will cause the file logging to be enabled.

      Also, we generally discourage text logging, and try to encourage customers to use binary logging. So I would recommend changing the code at annotation 2 to:
      code:swift
      config.usePlainText = false
      code

      The description could then be something like:
      Set the logging format to binary by disabling text logging. This is the default, and is only shown here for reference.

      Attachments

        Activity

          People

            elliot.hunter Elliot Hunter
            callum.birks Callum Birks
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:

              PagerDuty