Go to file
Jessica Grebenschikov e19e3c1101 pkg/process:
Now that we are trying to identify the root cause of the satellite load limitations (i.e. currently the satellite has a max ability of 400 rps for uploads and we need this to be higher), we are using the golang diagnostic tools to collect insight into what the bottlenecks are.  We currently have a debug endpoint to gather some cpu and mem data, but it could be useful to have continuous profiling. GCP stackdriver has support for continuous profiling so lets set that up and see if it is helpful to gather more data.

This PR adds support for [GCP continuous profiler](https://cloud.google.com/profiler) which allows enabling continuous cpu/mem profiling and the stats are sent to stackdriver in google cloud console.

To enable the continuous profiling for a storj component, do the following:
- prereq: the workload must be running in GKE and have Stackdriver Profiling IAM role permissions
- provide the config flag `debug.profilename` in the config.yaml file for the workload (i.e. satellite api process, etc). The profilename should be the workload name, for example "satellite-api".
- once the above config flag is provided, the profiler will be initialized and profiling stats will automatically be sent to GCP project where the workload is running and viewable in the Stackdriver Profile page in the console

The current implementation assumes the workload is running in GKE, however if we find if useful we can add support to enable this from anywhere. But for simplicity, its configured this way assuming the main goal is to enable in production systems.

Change-Id: Ibf8ebe2df7bf06fdd4951ee6a1e48854dd36ad47
2020-02-25 09:04:23 -08:00
.github pr template: migrations run concurrently with api servers now 2019-10-31 09:27:46 -06:00
certificate all: use monkit v3 2020-02-05 23:53:17 +00:00
cmd pkg/process: 2020-02-25 09:04:23 -08:00
docs satellite/satellitedb: use queue for orders to get back fast billing 2020-02-24 17:07:07 +00:00
examples go.mod: update uplink 2020-02-21 16:08:12 +02:00
installer/windows installer/windows: add service dependency for storagenode 2020-02-07 17:05:30 +00:00
lib go.mod: update uplink 2020-02-21 16:08:12 +02:00
linksharing mod: bump common and uplink version 2020-02-12 14:33:54 +00:00
pkg pkg/process: 2020-02-25 09:04:23 -08:00
private private/prompt: remove dependency to go-prompt 2020-02-25 13:09:41 +02:00
resources Add LE CA to satellite and storagenode images (#1688) 2019-04-08 13:06:01 -04:00
satellite satellite/repair: fix repair concurrency 2020-02-24 19:57:09 +00:00
scripts pkg/process: 2020-02-25 09:04:23 -08:00
storage storage: delete unused code and lower visibility of static iterator 2020-02-17 14:53:54 +00:00
storagenode storagenode/piecestore: add workgroup to endpoint to prevent stray goroutine after shutdown 2020-02-24 21:38:52 +00:00
versioncontrol common: separate repository 2019-12-27 14:11:15 +02:00
web web/satellite: overview page implemented 2020-02-25 14:28:00 +00:00
.clabot Adding Monty Anderson to the CLA 2020-02-11 17:11:24 +00:00
.dockerignore Forward-port release-alpha8 build script issues (#1726) 2019-04-09 23:01:10 -06:00
.gitignore pkg/debug: separate debug endpoints to a server 2020-01-29 16:30:31 -05:00
.golangci.yml golangci: Enable new linter added to last release 2020-01-24 18:09:37 +00:00
CODE_OF_CONDUCT.md Adding CODE_OF_CONDUCT to storj/storj repo (#779) 2018-12-07 15:10:02 -05:00
docker-compose.yaml Use Postgres 9.6 for Jenkins builds (#3729) 2019-12-13 10:03:06 -05:00
go.mod pkg/process: 2020-02-25 09:04:23 -08:00
go.sum pkg/process: 2020-02-25 09:04:23 -08:00
Jenkinsfile jenkins: Update Jenkins to use -e POSTGRES_HOST_AUTH_METHOD=trust when running postgres. 2020-02-19 00:22:04 +00:00
Jenkinsfile.public jenkins: disable npm audit as its failing everything 2020-02-10 13:32:40 -07:00
LICENSE license code with agplv3 (#126) 2018-07-05 10:24:26 -04:00
Makefile cmd/gateway: use a separate repository 2020-02-24 10:03:03 +02:00
monkit.lock Add metrics to track rate limit. 2020-02-11 14:02:12 +00:00
package-lock.json Satellite api keys frontend (#1039) 2019-02-01 18:19:30 +02:00
README.md Update Coverage URL (#3737) 2019-12-30 21:21:24 +01:00

Storj V3 Network

Go Report Card Go Doc Coverage Status Alpha

Storj is building a decentralized cloud storage network. Check out our white paper for more info!


Storj is an S3-compatible platform and suite of decentralized applications that allows you to store data in a secure and decentralized manner. Your files are encrypted, broken into little pieces and stored in a global decentralized network of computers. Luckily, we also support allowing you (and only you) to retrieve those files!

Table of Contents

Contributing to Storj

All of our code for Storj v3 is open source. Have a code change you think would make Storj better? Please send a pull request along! Make sure to sign our Contributor License Agreement (CLA) first. See our license section for more details.

Have comments or bug reports? Want to propose a PR before hand-crafting it? Jump on to our forum and join the Engineering Discussions to say hi to the developer community and to talk to the Storj core team.

Want to vote on or suggest new features? Post it on ideas.storj.io.

Issue tracking and roadmap

See the breakdown of what we're building by checking out the following resources:

Install required packages

To get started running Storj locally, download and install the latest release of Go (at least Go 1.13) at golang.org.

You will also need Git. (brew install git, apt-get install git, etc). If you're building on Windows, you also need to install and have gcc setup correctly.

We support Linux, Mac, and Windows operating systems. Other operating systems supported by Go should also be able to run Storj.

Download and compile Storj

Aside about GOPATH: Go 1.11 supports a new feature called Go modules, and Storj has adopted Go module support. If you've used previous Go versions, Go modules no longer require a GOPATH environment variable. Go by default falls back to the old behavior if you check out code inside of the directory referenced by your GOPATH variable, so make sure to use another directory, unset GOPATH entirely, or set GO111MODULE=on before continuing with these instructions.

First, fork our repo and clone your copy of our repository.

git clone git@github.com:<your-username>/storj storj
cd storj

Then, let's install Storj.

go install -v ./cmd/...

Make changes and test

Make the changes you want to see! Once you're done, you can run all of the unit tests:

go test -v ./...

You can also execute only a single test package if you like. For example: go test ./pkg/identity. Add -v for more informations about the executed unit tests.

Push up a pull request

Use Git to push your changes to your fork:

git commit -a -m 'my changes!'
git push origin master

Use Github to open a pull request!

Start using Storj

Our wiki has documentation and tutorials. Check out these three tutorials:

License

The network under construction (this repo) is currently licensed with the AGPLv3 license. Once the network reaches beta phase, we will be licensing all client-side code via the Apache v2 license.

For code released under the AGPLv3, we request that contributors sign our Contributor License Agreement (CLA) so that we can relicense the code under Apache v2, or other licenses in the future.

Support

If you have any questions or suggestions please reach out to us on our community forum or email us at support@tardigrade.io.