Skip to content

Latest commit

 

History

History
139 lines (93 loc) · 4.5 KB

advanced.md

File metadata and controls

139 lines (93 loc) · 4.5 KB
Raw

Advanced Topics

This page presents advanced information in a not so structured manner. It is used as both a reference for external and internal developers, and therefore rewards flexibility over structure.

Examples

Multiple netius examples can be found in the Examples page.

Python 3

The migration to Python 3 is not easy and as such a compatibility layer was created under the name of legacy.py. This file should be the primary source of functionality related with the compatibility between Python 2 and Python 3 and all the code regarding the transition should be store there and used from there.

WSGI

WSGI specification is specially problematic regarding the Python 3 unicode vs bytes problem and a common specification for how to solve this is still pending, please refer to the links section for more information regarding problems and solutions for Python 3 and WSGI.

Links

Configuration

"SSL_CONTEXTS" : {
    "localhost" : {
        "key_file" : "/secret.key",
        "cer_file" : "/secret.cer"
    }
}

Benchmarks

Apache Benchmark (ab)

To install ab run scu install apache.

Running ab -n 20000 -c 5 -k http://localhost:9090/ should achieve the following results:

  • HelloServer PORT=9090 python -m netius.extra.hello - 14.3 K req/sec
  • WSGIServer PORT=9090 python -m netius.servers.wsgi - 9.6 K req/sec

h2Load Benchmark

To install h2load run scu install nghttp2.

Running h2load -n20000 -c5 -m100 --h1 http://localhost:9090 should achieve the following results:

  • HelloServer PORT=9090 python -m netius.extra.hello - 17.8 K req/sec
  • WSGIServer PORT=9090 python -m netius.servers.wsgi - 13.2 K req/sec

Using multiple children the results should increase in a linear way:

  • HelloServer CHILDREN=4 PORT=9090 python -m netius.extra.hello - 44.6 K req/sec
  • WSGIServer CHILDREN=4 PORT=9090 python -m netius.extra.wsgi - 33.0 K req/sec
  • HelloServer PyPy CHILDREN=4 PORT=9090 pypy -m netius.extra.hello - 188.7 K req/sec
  • WSGIServer PyPy CHILDREN=4 PORT=9090 pypy -m netius.extra.hello - 165.4 K req/sec

Notes

These values have been verified for commit #008ba53 running in Python 2.7.11.

The results are a result of executing the benchmark on servidor4.hive.

Compliance

HTTP2

The h2spec tools allows proper verification of the RFC 5741 statements on a quick fashion.

scu install go
export GOPATH=~/go
mkdir -p ~/go
go get github.com/summerwind/h2spec/cmd/h2spec
~/go/bin/h2spec -h localhost -p 9090 -t -k

Cryptography

Netius has some built-in cryptography utilities. The following are some examples of RSA key operations that can be tested through the command line:

python -m netius.sh.rsa read_private private.key
python -m netius.sh.rsa read_public public.pub
python -m netius.sh.rsa private_to_public private.key public.pub

DKIM is an infra-structure for signing SMTP based messages which provides a way to avoid unwanted SPAM tagging. Netius provides a series of utilities for DKIM processing, here are some examples:

python -m netius.sh.dkim generate hive.pt
python -m netius.sh.dkim sign hello.mail dkim.key 20140327175143 hive.pt

To generate a password protected by a cryptographic hash to be used with the netius authentication/authorization infra-structure use:

python -m netius.sh.auth generate your_password

IPv6

Netius is compatible with IPv6. To activate this mode set the IPV6 configuration variable to a valid value (eg: 1 or True), and an IPv6 socket will be used instead.

IPV6=1 MESSAGE="Hello Netius" python -m netius.extra.hello

Debugging

It's important to keep track of the memory leaks that may be created by any circular references or unclosed resources associated with a netius server. For that purpose, a special document has been created, documenting the various tools and strategies that may be used to detect such leaks.

Testing

Edge triggered polling

Edge based polling is a bit tricky as it may easily end up in a data deadlock. The best way to test this kind of problem is to change the POLL_TIMEOUT value to a negative value so that the loop blocks for data:

LEVEL=DEBUG POLL_TIMEOUT=-1 BASE_PATH=/ python -m netius.extra.file

Then try to extract a really large file from this server (eg: 1.0 GB) and see if it is able to serve it without any problems.