appium-log-reader

KO | EN

gitlite — search

#javascript #python #react #ai #typescript #llm #go #machine-learning #rust #java #cli #vue #mcp #openai

appium-log-reader

(★ 10)

Appium log reader is a simple viewer that works with the Appium logs. It supports filtering, searching, highlighting and many other useful features.

appium-log-reader 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![charly](http://open.mobileboxlab.com/img/log-appium.gif)
___

[![Build Status](https://travis-ci.org/mobileboxlab/appium-log-reader.svg?branch=master)](https://travis-ci.org/mobileboxlab/appium-log-reader) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/6bb1301af08048b782c166c7c7dfd3a1)](https://www.codacy.com/app/dev-mobileboxlab/appium-log-reader?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=mobileboxlab/appium-log-reader&amp;utm_campaign=Badge_Grade)

**Appium Log Reader** is a simple viewer that works with the Appium logs. It supports filtering, searching, highlighting and many other useful features.

[Appium](http://appium.io) has a built-in mechanism in order to post messages to an external Webhook. They make use of normal HTTP requests with a JSON payload that includes a log message and the log level. This service listens these messages.

You can also use **Appium Log Reader** as an [API](https://github.com/mobileboxlab/appium-log-reader#http-api).

---

![Dashboard](https://raw.githubusercontent.com/mobileboxlab/appium-log-reader/master/doc/dashboard.gif)

## Features

- A great Appium log HTTP API.
  - View, filter, searching and and export logs in different formats such as: XLS, CSV, TXT, JSON, SQL, etc.
  - Localized log levels.
  - Shortcut to search errors messages on [DuckDuckGo](https://duckduckgo.com)
  
  ![Error](https://raw.githubusercontent.com/mobileboxlab/appium-log-reader/master/doc/error.png)

# Prerequisites

You will need:
* [Java](https://www.java.com)
* [Appium](http://appium.io)

# Getting Started

* Download the latest version of [Appium Log Reader](https://github.com/mobileboxlab/appium-log-reader/releases) (requires JDK 1.8 or newer) and install Appium
* Start **Appium Log Reader**:

```bash
java - jar appium-log-reader-service-X.X.X.jar -p 5000
```

* Start **Appium** using **--webhook** flag. This flag enable the log output to HTTP listener:

```bash
appium --webhook 127.0.0.1:5000 
```

* Navigate to [http://127.0.0.1:5000/dashboard](http://127.0.0.1:5000/dashboard) to view the dashboard.

## Docker
An alternative way to run the **Appium Log Reader** is via Docker:
**TODO**

# HTTP API

Appium Log Reader’s HTTP API serves two primary purposes:

* The Appium Log Reader API gives you a way to embed Appium logs into another webpage or a third-party application.

* Programmatic search for logs. Most common tasks you might want to do outside the Appium console output or Appium Log Reader Dashboard, like searching programmatically for logs and retrieving logs during a certain time period, etc.

## URL structure

The Appium Log Reader API lives at [http://127.0.0.1:5000/api/v1/](http://127.0.0.1:5000/api/v1/), with particular endpoints following that prefix.

Responses are in **JSON** (except for some endpoint that are used on the Dashboard)

## Errors

Failed requests return **400 Bad Request**, and a JSON hash is provided containing a key called message with further information about the issue. For example:

```json
{
 "code": "ERROR_CODE",
 "message": "Error description"
}
```

* If the resource is not found, **404 Not Found** is returned.

## Example calls

API examples use [httpie](https://httpie.org), a command-line HTTP client.

Retrieve a collection of all log messages:

```bash
http http://127.0.0.1:5000/api/v1/logs
```
**Response**

```json
{
  "data": {
    "items": [
      {
        "time": "2018.05.17.11.09.39",
        "message": "[Appium] Appium REST http interface listener started on 0.0.0.0:4723",
        "level": "info"
      },
      {
        "time": "2018.05.17.11.09.39",
        "message": "[Appium] Appium support for versions of node < 8 has been deprecated and will be removed in a future version. Please upgrade!",
        "level": "warn"
      },
      {
        "time": "2018.05.17.11.09.39",
        "message": "[Appium]   webhook: 127.0.0.1:5000",
        "level": "info"
      },
      {
        "time": "2018.05.17.11.09.39",
        "message": "[Appium] Welcome to Appium v1.8.0",
        "level": "info"
      },
      {
        "time": "2018.05.17.11.09.39",
        "message": "[Appium] Non-default server args:",
        "level": "info"
      }
    ],
    "size": 5
  }
}
```

Retrieve the last log message:

```bash
http http://127.0.0.1:5000/api/v1/logs/last
```

**Response**

```json
{
  "data": {
    "time": "2018.05.17.11.09.39",
    "message": "[Appium] Appium REST http interface listener started on 0.0.0.0:4723",
    "level": "info"
  }
}
```

Retrieve N lines of log (from the top):

```bash
http http://127.0.0.1:5000/api/v1/logs/1
```

**Response**

```json
{
  "data": {
    "items": [
      {
        "time": "2018.05.17.11.09.39",
        "message": "[Appium] Received SIGINT - shutting down",
        "level": "info"
      }
    ],
    "size": 1
  }
}
```

Post your own log message:

```bash
http  http://127.0.0.1:5000/ params:='{"message": "My message", "level": "info" }'
```

# API Documentation

We use [apiDoc](http://apidocjs.com/) in order to generate the [documentation](https://mobileboxlab.github.io/appium-log-reader/) for Appium Log Reader’s HTTP API.

**apiDoc** creates a documentation from API annotations in your source code. Please check the documentation [here](http://apidocjs.com/#params)

The proyect come with a Maven task in order to generate the documentation from Maven without any pain, but FIRST you need install **apiDoc** of course:

```bash
npm install apidoc -g 
```

And now we need execute the following command:

```bash
mvn exec:exec
```

The documentation is generated on the **doc** directory.

## Contribution

Any ideas are welcome. Feel free to submit any issues or pull requests.

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

---
**Appium Log Reader** is developed and maintained by [Mobilebox](http://mobileboxlab.com) team.

appium-log-reader

appium-log-reader 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

appium-log-reader

appium-log-reader 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README