README
¶
Octopus Service
Interpreter service for octopus language
Installation
go get -v github.com/cuttle-ai/octopus-service
Usage
Navigate into the project directory and run the following command
go run main.go
Environment Variables
| Enivironment Variable | Description |
|---|---|
| PORT | Port on to which application server listens to. Default value is 8080 |
| RESPONSE_TIMEOUT | Timeout for the server to write response. Default value is 100ms |
| REQUEST_BODY_READ_TIMEOUT | Timeout for reading the request body send to the server. Default value is 20ms |
| RESPONSE_BODY_WRITE_TIMEOUT | Timeout for writing the response body. Default value is 20ms |
| PRODUCTION | Flag to denote whether the server is running in production. Default value is false |
| SKIP_VAULT | Skip loading the configurations from vault server. Default value is false. |
| IS_TEST | Denoting the run is test. This will load the test configuration from vault |
| MAX_REQUESTS | Maximum no. of concurrent requests supported by the server. Default value is 1000 |
| REQUEST_CLEAN_UP_CHECK | Time interval after which error request app context cleanup has to be done. Default value is 2m |
Author
Melvin Davismelvinodsa@gmail.com
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config will have necessary configuration for the application
|
Package config will have necessary configuration for the application |
|
Package datastores has the utilities to access the datastore services
|
Package datastores has the utilities to access the datastore services |
|
Package db has the utilities required for the db interaction for the service
|
Package db has the utilities required for the db interaction for the service |
|
Package dict will have necessary configuration dictionary in the application
|
Package dict will have necessary configuration dictionary in the application |
|
Package log is used to print logs based of log types
|
Package log is used to print logs based of log types |
|
Package routes has the routes supported by the api with proper versioning done Suppose a route is /list, it belonged to v2 and current version is v2.
|
Package routes has the routes supported by the api with proper versioning done Suppose a route is /list, it belonged to v2 and current version is v2. |
|
dashboard
Package dashboard has the implementation of the dashboard api for the server
|
Package dashboard has the implementation of the dashboard api for the server |
|
dict
Package dict has the implementation of the dictionary api for the server
|
Package dict has the implementation of the dictionary api for the server |
|
interpreter
Package interpreter has the implementation of the interpreter api for the server
|
Package interpreter has the implementation of the interpreter api for the server |
|
response
Package response handles utilities for writing error and normal responses to the response writer
|
Package response handles utilities for writing error and normal responses to the response writer |
|
Package version has the version information about the application
|
Package version has the version information about the application |
Click to show internal directories.
Click to hide internal directories.