Developer

Getting Started with Supportability

Set up your Android environment and get familiar with logging and tracing components.

Getting Started

  • Environment Set Up
    Follow the environment setup documentation for using gradle if developing your mobile app in Android Studio. See Setting Up the Android Development Environment. After extracting the libraries and resources, make sure your application references these libraries:
    • SupportabilityFacade-*.jar
    • ClientLog-*.jar
    • E2ETrace-*.jar
    • simple-xml-*.jar
    • HttpConversation-*.jar
    • HttpConvAuthFlows-*.jar
  • Requirements
    • Minimum Android SDK version: 4.0.2 (14)
    • Target Android SDK version: 4.4 (19)
  • Architecture

  • SupportabilityFacade Component: provides an additional level of abstraction; prevents developers from interacting directly with the underlying sub-components.
  • ClientLog Component: includes a set of logging related management and the consumer interfaces and classes.
  • E2ETrace Component: includes a set of E2E tracing related management and the consumer interfaces and classes.
Public interfaces include:
  • com.sap.smp.client.supportability.Supportability: an abstraction on top of the underlying E2ETrace and ClientLogger components. Clients retrieve the required management and consumer instances via the exposed APIs and factory methods.
  • com.sap.smp.client.supportability.ClientLogManager: the central access point to loggers; provides setters to common properties used by various loggers.
  • com.sap.smp.client.supportability.ClientLogger: defines the interface for client loggers. The ClientLog library provides a default implementation.
  • com.sap.smp.client.supportability.E2ETraceManager: provides management API for End-To-End tracing. The E2ETraceManager library provides a default implementation.
  • com.sap.smp.client.supportability.E2ETrace: clients should use the APIs exposed by the E2ETrace interface when implementing end-to-end tracing.