That's a dead link pointing to an o'reilly 404 page

cc @maxbrunet

https://cloud-native.slack.com/archives/C01BB0M6K1U/p1644325866492779

Currently, the documentation only talks about XOR encoding, but we utilize run-length and double-delta encodings as well. These should be documented and explained why they are better suited where they are used.

Better to use Observability document and give examples over SLOs.

parca-dev/parca#522

Needs a newer release than parca-agent v0.3.0

cc @mskarbek @derekparker

Following the example on https://github.com/parca-dev/parca.dev/blob/main/docs/kubernetes.mdx isn't working as expected.

Expected behaviour

$ kubectl apply -f https://github.com/parca-dev/parca/releases/download/v0.7.1/kubernetes-manifest.yaml

Should create all required resources and allow me to see the UI via

$ kubectl -n parca port-forward service/parca 7070

Actual behaviour

$ kubectl apply -f https://github.com/parca-dev/parca/releases/download/v0.7.1/kubernetes-manifest.yaml
Warning: resource namespaces/parca is missing the kubectl.kubernetes.io/last-applied-configuration annotation which is required by kubectl apply. kubectl apply should only be used on resources created declaratively by either kubectl create --save-config or kubectl apply. The missing annotation will be patched automatically.
namespace/parca configured
configmap/parca-config created
deployment.apps/parca created
namespace/parca unchanged
podsecuritypolicy.policy/parca created
role.rbac.authorization.k8s.io/parca created
rolebinding.rbac.authorization.k8s.io/parca created
service/parca created
$ kubectl -n parca port-forward service/parca 7070
error: unable to forward port because pod is not running. Current status=Pending
$ kubens parca
Context "minikube" modified.
Active namespace is "parca".
$ oc get pods
NAME                     READY   STATUS    RESTARTS   AGE
parca-58c8487fcf-tk8zd   0/1     Pending   0          114s
$ oc describe pod parca-58c8487fcf-tk8zd
Name:           parca-58c8487fcf-tk8zd
Namespace:      parca
Priority:       0
Node:           <none>
Labels:         app.kubernetes.io/component=observability
                app.kubernetes.io/instance=parca
                app.kubernetes.io/name=parca
                app.kubernetes.io/version=v0.7.1
                pod-template-hash=58c8487fcf
Annotations:    <none>
Status:         Pending
IP:
IPs:            <none>
Controlled By:  ReplicaSet/parca-58c8487fcf
Containers:
  parca:
    Image:      ghcr.io/parca-dev/parca:v0.7.1
    Port:       7070/TCP
    Host Port:  0/TCP
    Args:
      /parca
      --config-path=/var/parca/parca.yaml
      --log-level=info
      --cors-allowed-origins=*
    Liveness:     exec [/grpc-health-probe -v -addr=:7070] delay=5s timeout=1s period=10s #success=1 #failure=3
    Readiness:    exec [/grpc-health-probe -v -addr=:7070] delay=10s timeout=1s period=10s #success=1 #failure=3
    Environment:  <none>
    Mounts:
      /var/parca from parca-config (rw)
      /var/run/secrets/kubernetes.io/serviceaccount from parca-token-d4cx2 (ro)
Conditions:
  Type           Status
  PodScheduled   False
Volumes:
  parca-config:
    Type:      ConfigMap (a volume populated by a ConfigMap)
    Name:      parca-config
    Optional:  false
  parca-token-d4cx2:
    Type:        Secret (a volume populated by a Secret)
    SecretName:  parca-token-d4cx2
    Optional:    false
QoS Class:       BestEffort
Node-Selectors:  kubernetes.io/arch=amd64
                 kubernetes.io/os=linux
Tolerations:     node.kubernetes.io/not-ready:NoExecute op=Exists for 300s
                 node.kubernetes.io/unreachable:NoExecute op=Exists for 300s
Events:
  Type     Reason            Age                  From               Message
  ----     ------            ----                 ----               -------
  Warning  FailedScheduling  65s (x3 over 2m14s)  default-scheduler  0/1 nodes are available: 1 node(s) didn't match Pod's node affinity.

Environment

Macbook Pro M1

$ uname -a
Darwin MAC-FVFGH12JQ05P 21.3.0 Darwin Kernel Version 21.3.0: Wed Jan  5 21:37:58 PST 2022; root:xnu-8019.80.24~20/RELEASE_ARM64_T8101 arm64

Analysis

The problematic part is:

Node-Selectors:  kubernetes.io/arch=amd64
                 kubernetes.io/os=linux

The parca.yaml that is downloaded via cURL in the tutorial "Parca from Binary" uses the main's version, which currently does not work with the version used in the previous cURL calls to download the binary (v0.12.0). Instead, the parca.yaml from the same tag should be used.

We already have plenty of frequently asked questions. We should probably have a dedicated docs page as well as an FAQ on the landing page.

What languages are currently supported?

Infrastructure-wide profiling with Parca Agent currently supports all compiled languages, eg. C, C++, Rust, Go (with extended support for Go). Further language support coming in the upcoming weeks and months.

Parca itself supports any pprof formatted profile. Any library or implementation that outputs valid pprof profiles is supported by Parca.

What overhead does running always-on profiling have with Parca Agent?

We have observed <1% in CPU, but more elaborate and reproducible reports coming soon.

Parca Agent has to run as root for eBPF, what are the security considerations?

• The profiler source code is open source, so anyone can inspect the code that would be running as root on their servers.
• It is written in Go, a memory-safe language.
• Binaries and container images are fully reproducible, so users can ensure that the artifacts they are running are exactly the same as the ones we are distributing.

Read the docs on more in-depth explanations on security considerations

Does Parca upload binaries or our code?

No. Profiling data is made up of statistics representing for example how much time the CPU has spent in a particular function, but the function metadata is decoupled from the actual executable and source code.

Read the docs on symbolization to understand further why.

If all data were to leak, what would be the worst-case scenario?

Function, package, and file names would leak, but no executable code.

Read the docs on symbolization to understand further why.

Merge setup instructions at https://www.parca.dev/docs/agent-binary and https://www.parca.dev/docs/systemd to remove redundancy and improve clarity.

How do I as a user know what to choose here? Maybe we can at least open an issue on the docs repo to clarify what this is, what it means and how to configure it?

Originally posted by @brancz in parca-dev/parca#314 (comment)

I followed https://www.parca.dev/docs/systemd which contains a yaml file example like:

debug_info:
  bucket:
    type: "FILESYSTEM"
    config:
      directory: "/tmp"
  cache:
    type: "FILESYSTEM"
    config:
      directory: "/tmp"

scrape_configs:
  - job_name: "default"
    scrape_interval: "2s"
    static_configs:
      - targets: ["127.0.0.1:7070"]

However this fails to start, with an error like:

level=error name=parca ts=2022-11-22T10:51:43.582639041Z caller=main.go:59 msg="Program exited with error" err="parsing YAML file /etc/parca/parca.yaml: yaml: unmarshal errors:\n  line 1: field debug_info not found in type config.Config"

AFAICS this is because debug_info is no longer valid since parca-dev/parca#1403 - instead I used a config like this:

object_storage:
  bucket:
    type: "FILESYSTEM"
    config:
      directory: "/tmp"

scrape_configs:
  - job_name: "default"
    scrape_interval: "2s"
    static_configs:
      - targets: ["127.0.0.1:7070"]

We should provide examples or thorough description of how pull based approach works for ingestion. This is especially useful for the types of profiles which are still not supported by parca-agent.

To publish blog posts from the Parca team
To highlight blog posts about Parca

After deploying the server I got this:

Warning: resource namespaces/parca is missing the kubectl.kubernetes.io/last-applied-configuration annotation which is required by oc apply. oc apply should only be used on resources created declaratively by either oc create --save-config or oc apply. The missing annotation will be patched automatically.
....
....
W1014 14:33:28.076094   60726 warnings.go:70] policy/v1beta1 PodSecurityPolicy is deprecated in v1.21+, unavailable in v1.25+
W1014 14:33:28.204159   60726 warnings.go:70] policy/v1beta1 PodSecurityPolicy is deprecated in v1.21+, unavailable in v1.25+

I got the following warning after applying agent on OpenShift v4.10:

W1014 14:35:06.649758   60757 warnings.go:70] would violate "latest" version of "baseline" PodSecurity profile: non-default capabilities (container "parca-agent" must not include "SYS_ADMIN" in securityContext.capabilities.add), host namespaces (hostPID=true), hostPath volumes (volumes "root", "proc", "run", "cgroup", "modules", "bpffs", "debugfs", "localtime"), hostPort (container "parca-agent" uses hostPort 7071), privileged (container "parca-agent" must not set securityContext.privileged=true)

xref: parca-dev/parca-agent#627

cc @javierhonduco

The default CPU profiling frequency has been updated parca-dev/parca-agent#1213, so the docs should be synced as well before the next release.

TODO

• Update docs
• Update diagrams parca-dev/parca-agent#1213 (comment)

• How to build binaries with debug info

• How to split debug info and upload

• How to discover linked shared libraries and provide debug information for those using package managers

• Examples for language runtimes

cc @Sylfrena

@parca-dev/parca-demo could be used as an example

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

• chore(deps): update dependency node to v20
• fix(deps): update dependency @rive-app/react-canvas to v4
• fix(deps): update dependency @svgr/webpack to v8
• fix(deps): update dependency clsx to v2
• fix(deps): update dependency prism-react-renderer to v2
• fix(deps): update docusaurus monorepo to v3 (major) (@docusaurus/core, @docusaurus/preset-classic, @docusaurus/theme-search-algolia)
• 🔐 Create all pending approval PRs at once 🔐

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): npm Lock file maintenance

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update dependency @mdx-js/react to v3

Detected dependencies

• Check this box to trigger a request for Renovate to run again on this repository

Nice!
Seems worth automating to have it always up-to-date. It's not too bad to do it manually, but I did not release the versions between v0.8 and v0.12 cause I simply forgot. 🤷‍♂️

Originally posted by @metalmatze in parca-dev/parca#1491 (comment)

Add a page to list links to the Parca design documents or proposals

https://docusaurus.io/docs/search

Currently, we just double-commit all docs, but we can use https://www.npmjs.com/package/docusaurus-plugin-remote-content

Add tutorial on how to configure object storage for debuginfo storage.

The docs agent release e.g here resolves to v0.10.0-rc.1, but that release drops support for the --systemd-units flag since parca-dev/parca-agent#627 removed it.

$ grep -R systemd-units
docs/agent-binary.mdx:sudo parca-agent --node=systemd-test --systemd-units=docker.service --log-level=debug --kubernetes=false --store-address=localhost:7070 --insecure
docs/parca-agent-systemd.mdx:      --systemd-units=SYSTEMD-UNITS,...
docs/parca-agent-systemd.mdx:To profile units, you just need to specify the name of the service in `--systemd-units` flag.
docs/parca-agent-systemd.mdx:+  --systemd-units=docker.service,my-app.service \
docs/systemd.mdx:ExecStart=/usr/bin/parca-agent --http-address=":7071" --node=systemd-test --systemd-units=docker.service,parca.service,parca-agent.service --kubernetes=false --store-address=localhost:7070 --insecure
src/components/HomepageQuickstart.js:./parca-agent --node=systemd-test --systemd-units=parca-agent.service --kubernetes=false`

It also looks like --kubernetes=false is no longer valid - should these both just be removed?

parca-dev/parca-agent#1277

Document every field with their description, type and default value