[SYNPY-1320] Upload benchmark + Documentation

[BryanFauble]

Problem:

1. OTEL context propagation was broken due to the custom threading in the sync functions
2. We did not have upload benchmarks documented
3. Documentation in the README was lacking for programmatic access

Solution:

1. Propagate the OTEL context into the syn.store function
2. Create documentation in the benchmarking rst
3. Add some examples to the README that talk over some common use-cases for file/folder/project creation

Testing:

1. I ran and collected the benchmark information on EC2

[pep8speaks]

Hello @BryanFauble! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file synapseclient/client.py:

Line 1252:89: E501 line too long (114 > 88 characters)
Line 1253:89: E501 line too long (110 > 88 characters)
Line 1314:89: E501 line too long (96 > 88 characters)
Line 1331:89: E501 line too long (96 > 88 characters)
Line 1368:89: E501 line too long (90 > 88 characters)
Line 1404:89: E501 line too long (95 > 88 characters)
Line 1438:89: E501 line too long (109 > 88 characters)
Line 1480:89: E501 line too long (110 > 88 characters)
Line 1481:89: E501 line too long (106 > 88 characters)
Line 1508:89: E501 line too long (89 > 88 characters)
Line 1512:89: E501 line too long (95 > 88 characters)

Comment last updated at 2023-11-16 17:56:42 UTC

[BryanFauble]

Adding this with is the only real change here - The sync functions multi-thread at this point and OTEL context was not propagating

[danlu1]

Do you mind adding the explanation of opentelemetry_context parameter in the function docstring?

[thomasyu888]

🔥 Looks great to me! I'm going to pre-approve.

I do realize we've baked in otel contexts throughout the code which adds a layer of nesting sometimes which is ok. In the beginning, I was wondering if there was a way for that code to exist without the opentel packages installed (so we don't always require the dependency) but this is great.

[BryanFauble]

I do realize we've baked in otel contexts throughout the code which adds a layer of nesting sometimes which is ok. In the beginning, I was wondering if there was a way for that code to exist without the opentel packages installed (so we don't always require the dependency) but this is great.

Yeah I agree with you here - Unfortunately the way we are doing manually instrumenting the client + the way multi-threading is set up leading to some less than savory code. Fortunately with all testing I've done with asyncio - This kind of context propagation is no longer required.

[danlu1]

Nit: could you rephrase this sentence? It has two verbs.

[BryanFauble]

I modified this slightly - Let me know if this new version sounds better:

This is the recommended way of synchronizing more than one file or directory to a synapse project through the use of synapseutils. Using this library allows us to handle scheduling everything required to sync an entire directory tree. Read more about the manifest file format in synapseutils.syncToSynapse

[danlu1]

Looks great!

[danlu1]

Thanks for working on this. I approved the PR.