Skip to content

Fix iOS and Android SDK limits in documentation#709

Open
nelsitoPuglisi wants to merge 2 commits intomainfrom
fix/android-limits-documentation
Open

Fix iOS and Android SDK limits in documentation#709
nelsitoPuglisi wants to merge 2 commits intomainfrom
fix/android-limits-documentation

Conversation

@nelsitoPuglisi
Copy link
Contributor

@nelsitoPuglisi nelsitoPuglisi commented Feb 25, 2026

Summary

Corrected limit values in documentation that were outdated compared to the actual SDK implementations. Values were verified against embrace-android-sdk and embrace-apple-sdk source code.

Note: docs/android/features/traces.md limits were already correct in main — no changes needed there.


Android changes (shared/ components)

File Field Old value New value SDK source
shared/log-limit.md Properties per log 10 100 EmbraceLogService.MAX_PROPERTY_COUNT
shared/log-limit.md Property value length 256 chars 1024 chars EmbraceLogService.MAX_PROPERTY_VALUE_LENGTH
shared/property-limit.md Property value length 256 chars 1024 chars SessionPropertiesServiceImpl.SESSION_PROPERTY_VALUE_LIMIT

Shared components used by: integration-advanced/log-message-api, features/log-message-api, features/session-properties, features/moments


iOS 6x changes

File Field Old value New value SDK source
docs/ios/6x/core-concepts/logs.md Log message size 10,000 bytes 4,000 characters LengthOfBodyValidator.allowedCharacterCount
docs/ios/6x/core-concepts/logs.md Log batch inactivity timeout 2 seconds 20 seconds DefaultEmbraceLoggerConfig.maximumTimeBetweenLogsInSeconds
docs/ios/6x/core-concepts/logs.md Log batch lifetime 5 seconds 60 seconds LogBatchLimits.maxBatchAge
docs/ios/6x/core-concepts/logs.md Logs per batch 50 20 LogController.maxLogsPerBatch
docs/ios/6x/core-concepts/traces-spans.md Span name max length (Naming Conventions) 50 chars 128 chars EmbraceSpanProcessor.nameLengthLimit
docs/ios/6x/core-concepts/traces-spans.md Key name max length (Naming Conventions) 50 chars removed No explicit limit found in SDK

Note: the Naming Conventions section in traces-spans.md was contradicting its own Trace Limits table (which already said 128 characters correctly).

Test plan

  • Review limit warnings in Android pages: features/log-message-api, integration-advanced/log-message-api, features/session-properties, features/moments
  • Review iOS 6x pages: core-concepts/logs, core-concepts/traces-spans
  • Confirm property value limits are also consistent with iOS 5x docs if needed

🤖 Generated with Claude Code

Corrected limits verified against embrace-android-sdk source:
- shared/log-limit.md: properties per log 10→100 (MAX_PROPERTY_COUNT),
  property value length 256→1024 (MAX_PROPERTY_VALUE_LENGTH)
- shared/property-limit.md: property value length 256→1024
  (SESSION_PROPERTY_VALUE_LIMIT)

Note: traces.md limits were already correct in main.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link

github-actions bot commented Feb 25, 2026

Summary - Markdown Lint

Success: No issues found in 392 files (105ms)

@github-actions
Copy link

github-actions bot commented Feb 25, 2026

Summary - Link Checker

Status Count
🔍 Total 470
✅ Successful 375
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 95
❓ Unknown 0
🚫 Errors 0
⛔ Unsupported 0
Full Github Actions output

Corrected limits verified against embrace-apple-sdk source:

logs.md:
- Log message size: "10,000 bytes" → "4,000 characters"
  (LengthOfBodyValidator.allowedCharacterCount = 0...4000)
- Log batch time between: 2s → 20s (maximumTimeBetweenLogsInSeconds)
- Log batch lifetime: 5s → 60s (LogBatchLimits.maxBatchAge)
- Logs per batch: 50 → 20 (LogController.maxLogsPerBatch)

traces-spans.md (Naming Conventions section):
- Span name max length: 50 → 128 characters (EmbraceSpanProcessor.nameLengthLimit)
- Removed unverified 50-char limit from Key Names convention

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@nelsitoPuglisi nelsitoPuglisi requested a review from a team as a code owner February 25, 2026 15:57
@nelsitoPuglisi nelsitoPuglisi changed the title Fix Android SDK limits in shared documentation components Fix iOS and Android SDK limits in documentation Feb 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant