mozilla-services / common-rs Goto Github PK

Currently many fields that are recommended for mozlog's request.summary event are also including the general tracing span values. This makes it harder for downstream consumers to control what is in their logs, and it unneededly bloats each log line in our current JSON formatter (which includes fields from all parent spans in each log line).

We should remove unneeded fields from this span, especially path and agent. The request ID field (rid) should stay in place, so that events can be tied together.

We are currently using deprecation warnings to generate compiler messages when either both or neither of the actix-web-v3 and actix-web-v4 features are being compiled. Instead, let's use the compile_error! macro to generate compiler errors:

#[cfg(all(feature = "actix-web-v3", feature = "actix-web-v4"))]
compile_error!("Only one of actix-web-v3 and actix-web-v4 can be used at once.");

#[cfg(not(any(feature = "actix-web-v3", feature = "actix-web-v4")))]
compile_error!("Exactly one of actix-web-v3 or actix-web-v4 must be specified.");

We're planning to deprecate mozilla/cidockerbases by October 1, 2022. This image is used in the CircleCI build, which should change to a different image such as one of the Pre-Built CircleCI Docker Images. See mozilla/ci-docker-bases#322 for more context, and a list of other projects that have made the transition.

We're intgrating actix-web-tracing-mozlog into a new project and would love a crate that incorporates 508a3c1 if possible.

Currently the JSON formatter performs several transformations of the data beyond formatting it as compatible JSON. This can be a problem for debugging or other environments that want to use human readable logs, but test the transformations that make this valid mozlog.

We should separate the two sets of concerns into two or more independent layers that can each be used separately.

Currently the mozlog formatter uses "<unknown>" as a value for any event that doesn't have a type field. This should be configurable by users of the library. One way this could be done is to add an optional layer that users can add that fills in a value for this field if none is provided by passing events to a bit of user-specified code. That code could inspect the event and determine the proper type.

Any events that arrive via the log facade's shim can't have a type field, which is a case we'll need to be able to handle. To that end it should be possible to determine where the event came from in the fallback code provided.

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please reach out to [email protected].

(Message COC001)

This project does not appear to be using cargo-audit (https://github.com/RustSec/cargo-audit) - that’s strongly recommended in order to be warned about dependencies with security vulnerabilities.
Note that this will require you to maintain a Cargo.lock file

We have a working circleci config that runs but the status checks aren't being sync'd with PRs. Nor can we block PRs on these status checks passing.

With actix-web-location now relying on a recent cadence which no longer wraps StatsdClient in an Arc, the LocationConfig should really take an instance the StatsdClient wrapped in an Arc, implying it will be shared between Location lookup and anything else in a thread safe fashion.

There is no example provided actix-web-location.

In the last two years Github, Mozilla and many orgs renamed master -> main as part of an inclusive language push. Would love to see that here. Happy to provide more context if it's needed.

x-forwarded-for headers from frontends tend include a list of proxy ip addresses encountered during the request, separated by a comma.

Certain frontends are known to send ip addresses with their port number included, e.g. 1.1.1.1:1026.

We're not currently handling these cases.