https://github.com/oslabs-beta/projectartemis
An analytic tool for GraphQL queries to external APIs with a Graphical User Interface to view performance metrics.
https://github.com/oslabs-beta/projectartemis
aleph analytics api deno graphql graphql-queries performance-metrics
Last synced: about 1 month ago
JSON representation
An analytic tool for GraphQL queries to external APIs with a Graphical User Interface to view performance metrics.
- Host: GitHub
- URL: https://github.com/oslabs-beta/projectartemis
- Owner: oslabs-beta
- License: mit
- Created: 2020-11-13T23:58:17.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-21T22:05:29.000Z (about 3 years ago)
- Last Synced: 2025-04-30T19:07:25.861Z (about 1 month ago)
- Topics: aleph, analytics, api, deno, graphql, graphql-queries, performance-metrics
- Language: TypeScript
- Homepage: http://www.artemis-deno.land
- Size: 25.3 MB
- Stars: 87
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
** Artemis is currently undergoing a major re-write. If you notice any bugs please report an issue. We apologize for the inconvenience. **
A Deno-built Analytics Tool for GraphQL Queries
Artemis
from Our Team
You can use Artemis without installing by visiting our online platform .
## Features
Artemis provides analytics including aggregate response time, success and error instance ratios, returned data size, and persistent individual snapshots of each successful query results.
## Overview
Artemis is Deno's first native GraphQL query analytics tool with a graphical user interface to visualize performance metrics.
Our dynamic GUI, compiled using Aleph.js, allows users to send query requests to external APIs that use GraphQL. Under the hood, sophisticated and performant algorithms calculate performance metrics for each query request and Artemis immediately displays them as accessible and digestible analytics for developers.
## To Get Started
To install Aleph, enter the following command in your terminal.
```javascript
deno install -A -f -n aleph https://deno.land/x/[email protected]/cli.ts
```
Remember to export to PATH.
To load the GUI on your localhost, enter the following command in your terminal.
```javascript
aleph dev
```
## Documentation and Demo
Simply enter the endpoint URL you are testing and select the number of times to run the query, then watch as Artemis visualized your results in real time. Here is a great resource for external APIs that work with GraphQL.
You'll notice the graphs will render dynamically.
**Please note the functionality to run numerous queries is still being worked on. Use the default Number of queries(1).**
## Making a Query
Syntax is extremely important for the success of your query.
Please refer to the following documentation if you are not familiar with GraphQL queries.
Here is an example of a query request to Space X's API.
```javascript
URL: https://api.spacex.land/graphql
Query:
{
launchesPast(limit: 10) {
mission_name
launch_date_local
launch_site {
site_name_long
}
rocket {
rocket_name
first_stage {
cores {
flight
core {
reuse_count
status
}
}
}
}
}
```
The following will be populated after:
## Authors
[Stella Liao](https://github.com/Stellaliao01)
[Erick Melendez](https://github.com/mlndz-la)
[Greg Dixon](https://github.com/greg-dixon)
[Taylor Morgan](https://github.com/TaylorMorgan7)
[Scott Burman](https://github.com/Scottburs)