Skip to content

signalfx/splunk-otel-ios


Getting Involved   •   Security

Stable OpenTelemetry Swift Splunk GDI specification GitHub release (latest SemVer) Build Status


Splunk RUM agent for iOS

The Splunk RUM agent for iOS provides a Swift package that captures:

  • HTTP requests, using URLSession instrumentation
  • Application startup information
  • UI activity - screen name (typically ViewController name), actions, and PresentationTransitions
  • Crashes/unhandled exceptions using SplunkRumCrashReporting

🚧 This project is currently in BETA. It is officially supported by Splunk. However, breaking changes MAY be introduced.

Requirements

Splunk RUM agent for iOS supports iOS 11 and higher, including iPadOS 13 and higher.

Getting Started

To get started, see Instrument iOS applications for Splunk RUM in the Splunk Observability Cloud documentation.

Crash Reporting

The Splunk iOS Crash Reporting module adds crash reporting to the iOS RUM agent using PLCrashReporter.

To activate Crash Reporting, see Activate crash reporting in the Splunk Observability Cloud documentation.

Manual OpenTelemetry instrumentation

You can manually instrument iOS applications for Splunk RUM using the iOS RUM agent to collect additional telemetry, sanitize Personal Identifiable Information (PII), add global attributes, and more. See Manually instrument iOS applications in the Splunk Observability Cloud documentation.

Contributing

See CONTRIBUTING.md for instructions on building, running tests, and so on.

Troubleshooting

For troubleshooting issues with the Splunk OpenTelemetry iOS instrumentation, see Troubleshoot iOS instrumentation for Splunk Observability Cloud in the official documentation.

License

This library is licensed under the terms of the Apache Softare License version 2.0. See the license file for more details.

ℹ️  SignalFx was acquired by Splunk in October 2019. See Splunk SignalFx for more information.