{"id":24755268,"url":"https://github.com/katzer/iss","last_synced_at":"2025-07-05T18:06:00.872Z","repository":{"id":138108819,"uuid":"95108027","full_name":"katzer/iss","owner":"katzer","description":"API endpoint for Orbit","archived":false,"fork":false,"pushed_at":"2024-08-30T19:59:07.000Z","size":339,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-01-28T12:42:06.271Z","etag":null,"topics":["api-service","cli","mruby-cli","orbit"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/katzer.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-22T11:22:22.000Z","updated_at":"2024-08-30T19:59:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"7156cae5-fb48-4170-8842-fae082da6799","html_url":"https://github.com/katzer/iss","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fiss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fiss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fiss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/katzer%2Fiss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/katzer","download_url":"https://codeload.github.com/katzer/iss/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245061376,"owners_count":20554563,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-service","cli","mruby-cli","orbit"],"created_at":"2025-01-28T12:38:00.143Z","updated_at":"2025-03-23T06:14:04.341Z","avatar_url":"https://github.com/katzer.png","language":"Ruby","readme":"# iss - The API endpoint for _Orbit_ \u003cbr\u003e [![GitHub release](https://img.shields.io/github/release/katzer/iss.svg)](https://github.com/katzer/iss/releases) [![Build Status](https://travis-ci.com/katzer/iss.svg?branch=master)](https://travis-ci.com/katzer/iss) [![Build status](https://ci.appveyor.com/api/projects/status/ihdgs8rtuexwtiv7/branch/master?svg=true)](https://ci.appveyor.com/project/katzer/iss/branch/master) [![Maintainability](https://api.codeclimate.com/v1/badges/5b6eefc8260ef6d6dd0f/maintainability)](https://codeclimate.com/github/katzer/iss/maintainability)\n\n    $ iss -h\n    \n    Usage: iss [options...]\n    Options:\n    -b, --bind        The host to bind the local server on\n                      Defaults to: 0.0.0.0\n    -c, --cleanup     Interval to cleanup forked processes\n                      Defaults to: 5 (sec)\n    -e, --environment The environment to run the server with\n    -p, --port        The port number to start the local server on\n                      Defaults to: 1974\n    -r, --routes      Print out all defined routes\n    -t, --timeout     Receive timeout before socket will be closed\n                      Defaults to: 1 (sec)\n    -w, --workers     The max amount of threads to work in parallel\n                      Defaults to: 20\n    -h, --help        This help text\n    -v, --version     Show version number\n\n## Prerequisites\n\nYou'll need to add `ORBIT_HOME` and `ORBIT_BIN` first to your profile:\n\n    $ export ORBIT_HOME=/path/to/orbit\n\nThen setup the SSH agent for passwordless authentication:\n\n    $ ssh-add /path/to/key\n\n## Installation\n\nDownload the latest version from the [release page][releases] and add the executable to your `PATH`.\n\n## Configuration\n\nThe tool expects to find the __iss.json__ file at `$ORBIT_HOME/config/iss.json`.\n\n```json\n{\n  \"planets\": \"type=server%location:apac|p27\",\n\n  \"files\": [\n    \"log/tcp_trace.*\",\n    \"log/th_*[^1-9][^2-9]\"\n  ],\n\n  \"Kafka\": {\n    \"planets\": \"type=server%location:apac|p27\",\n    \"files\": [\n      \"data/logs/kafka/server*\"\n    ]\n },\n\n  \"encodings\": {\n    \"log/th_*\": \"latin\"\n  },\n\n  \"timestamps\": [\n    [\"log/tcp_trace.*\", 0, \"Node\",       0, 21, \"d.m.y H:i:s.u\"],\n    [\"log/th_*\",        0, \"KM receive\", 0, 26, \"d.m.Y H:i:s.u\"]\n  ],\n\n  \"filters\": [\n    [\"log/tcp_trace.*\", 0, false, \"TRACE\", \"INFO\"]\n  ]\n}\n```\n\nTo reload the config at runtime:\n\n    $ kill -s USR1 pid\n\n## API\n\nAll endpoints return a JSON encoded result set.\n\n    $ iss --routes\n    GET /jobs\n    GET /jobs/{job_id}/reports\n    GET /jobs/{job_id}/reports/{id}/results\n    GET /planets\n    GET /planets/{id}\n    GET /planets/{id}/logs\n    GET /planets/{id}/logs/{path}\n    GET /stats\n    GET /stats/{type}/count\n    GET /stats/{type}/list\n    HEAD /ping\n\nFor example to get the total number of planets with type of _web_:\n\n    $ curl localhost:1974/stats/web/count\n\n## Web App\n\nThe tool expects to find the __index.html__ file and related ressources under `$ORBIT_HOME/public/iss`. The file `$ORBIT_HOME/public/iss/index.html` maps to `localhost:1974/iss/index.html`.\n\nAll static assets placed under the document root will become available. Don't put sensitive data there!\n\n## Development\n\nClone the repo:\n    \n    $ git clone https://github.com/katzer/iss.git \u0026\u0026 cd iss/\n\nInstall the dependencies:\n\n    $ bundle\n\nAnd then execute:\n\n    $ rake compile\n\nTo compile the sources locally for the host machine only:\n\n    $ MRUBY_CLI_LOCAL=1 rake compile\n\nYou'll be able to find the binaries in the following directories:\n\n- Linux (AMD64, Musl): `build/x86_64-alpine-linux-musl/bin/iss`\n- Linux (AMD64, GNU): `build/x86_64-pc-linux-gnu/bin/iss`\n- Linux (AMD64, for old distros): `build/x86_64-pc-linux-gnu-glibc-2.9/bin/iss`\n- OS X (AMD64): `build/x86_64-apple-darwin19/bin/iss`\n- OS X (ARM64): `build/arm64-apple-darwin19/bin/iss`\n- Windows (AMD64): `build/x86_64-w64-mingw32/bin/iss`\n- Host: `build/host/bin/iss`\n\nFor the complete list of build tasks:\n\n    $ rake -T\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/katzer/iss.\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n\n## License\n\nThe code is available as open source under the terms of the [Apache 2.0 License][license].\n\nMade with :heart: in Leipzig\n\n© 2016 [appPlant GmbH][appplant]\n\n[releases]: https://github.com/katzer/iss/releases\n[license]: http://opensource.org/licenses/Apache-2.0\n[appplant]: www.appplant.de\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatzer%2Fiss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkatzer%2Fiss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkatzer%2Fiss/lists"}