Skip to content

Commit

Permalink
wording update
Browse files Browse the repository at this point in the history 
Co-Authored-By: cswatt <[email protected]>
  • Loading branch information
@cswatt
Pierre Guceski and cswatt authored Jan 2, 2020
1 parent 548ccdf commit b16bd20
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
10 changes: 5 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@
## Getting Started

See the dedicated [Datadog Android log collection documentation](http://docs.datadoghq.com/logs/log_collection/android) to learn how to forward logs from your Androind application to Datadog.
See the dedicated [Datadog Android log collection documentation](http://docs.datadoghq.com/logs/log_collection/android) to learn how to forward logs from your Android application to Datadog.

### Migrating from earlier versions

If you were a user of the SDK version `0.2.5` or lower, take a look at our [Migration Guide](docs/Migrating_To_1.0.0.md).
If you are using SDK version `0.2.5` or lower, take a look at the [Migration Guide](docs/Migrating_To_1.0.0.md). There are some breaking changes introduced in version `1.0.0`.

### Integrating with Timber

If you're existing codebase is already using Timber, you can migrate to Datadog easily by using our [dedicated library](dd-sdk-android-timber/README.md).
If your existing codebase is already using Timber, you can migrate to Datadog easily by using the [dedicated library](dd-sdk-android-timber/README.md).

## Looking up your logs

When you open your console in Datadog, navigate to the Logs section, and in the search bar, type `source:mobile`. This will filter your logs to only show the ones coming from mobile applications (Android and iOS).
When you open your console in Datadog, navigate to the Logs section. In the search bar, type `source:mobile`. This filters your logs to only show the ones coming from mobile applications (Android and iOS).

![Datadog Mobile Logs](docs/images/screenshot.png)

## Contributing

Pull requests are welcome, but please open an issue first to discuss what you would like to change. For more information, read the [Contributing Guide](CONTRIBUTING.md).
Pull requests are welcome. First, open an issue to discuss what you would like to change. For more information, read the [Contributing Guide](CONTRIBUTING.md).

## License

Expand Down
6 changes: 3 additions & 3 deletions docs/Migrating_To_1.0.0.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ introduced in version `1.0.0`, namely:

#### Attributes

The attributes were created or removed with the `Logger.addField()` or `Logger.removeField()`
methods. These methods were rename for consistency purposes, and are now `Logger.addAttribute()`
and`Logger.removeAttribute()`, but they will behave the same way as the old ones.
In earlier versions, attributes were created or removed with the `Logger.addField()` or `Logger.removeField()`
methods. These methods were renamed for consistency purposes, and are now `Logger.addAttribute()`
and `Logger.removeAttribute()`. Their behavior remains the same.
10 changes: 5 additions & 5 deletions docs/log_collection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Send logs to Datadog from your Android applications with [Datadog's `dd-sdk-andr
}
```
2. Initialize the library with your application context and your Datadog Client token. A [Datadog client token][2] is used here for security reasons, [Datadog API keys][3] cannot be used to configure the `dd-sdk-android` library as they would be exposed client-side in the Android application APK byte code. For more information about setting up a client token, see the [Client token documentation][2]:
2. Initialize the library with your application context and your [Datadog client token][2]. For security reasons, you must use a client token: you cannot use [Datadog API keys][3] to configure the `dd-sdk-android` library as they would be exposed client-side in the Android application APK byte code. For more information about setting up a client token, see the [client token documentation][2]:
{{< tabs >}}
{{% tab "US" %}}
Expand Down Expand Up @@ -102,11 +102,11 @@ The following parameters can be used when initializing the logger to send logs t
| Method | Description |
|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `setNetworkInfoEnabled(true)` | Add `network.client.connectivity` attribute to all log. The data logged by default is `connectivity` (`Wifi`, `3G`, `4G`...) and `carrier_name` (`AT&T - US`). `Carrier_name` is only available for Android API level 28 and above. |
| `setServiceName(<SERVICE_NAME>)` | Set `<SERVICE_NAME>` as value for the `service` [standard attribute][4] attached to all log sent to Datadog. |
| `setServiceName(<SERVICE_NAME>)` | Set `<SERVICE_NAME>` as value for the `service` [standard attribute][4] attached to all logs sent to Datadog. |
| `setLogcatLogsEnabled(true)` | Set to `true` to use Logcat as logger. |
| `setDatadogLogsEnabled(true)` | Set to `true` to send logs to Datadog. |
| `setLoggerName(<LOGGER_NAME>)` | Set `<LOGGER_NAME>` as value for the `logger.name` attribute attached to all log sent to Datadog. |
| `setVerbosity(Log.INFO)` | Set the verbosity of the logger. All internal messages in the library with a priority equal or higher than the provided level will be logged to Android's LogCat. |
| `setLoggerName(<LOGGER_NAME>)` | Set `<LOGGER_NAME>` as the value for the `logger.name` attribute attached to all logs sent to Datadog. |
| `setVerbosity(Log.INFO)` | Set the verbosity of the logger. All internal messages in the library with a priority equal or higher than the provided level will be logged to Android's Logcat. |
| `build()` | Build a new logger instance with all options set. |
### Global configuration
Expand Down Expand Up @@ -144,7 +144,7 @@ logger.removeTagsWithKey("build_type")
##### Add attributes
By default, the following attributes are added to all logs send by a logger:
By default, the following attributes are added to all logs sent by a logger:
* `http.useragent` and its extracted `device` and `OS` properties
* `network.client.ip` and its extracted geographical properties (`country`, `city`)
Expand Down

0 comments on commit b16bd20

Please sign in to comment.