diff --git a/.cspell.yaml b/.cspell.yaml index 717670869..8f1961df5 100644 --- a/.cspell.yaml +++ b/.cspell.yaml @@ -10,16 +10,22 @@ ignoreRegExpList: - Slack Channel ID - Google Docs ID words: + - Collibra - DASD + - datadog - dynatrace - easycla - eiffel + - elastic - emea - faas - galkleinman - gitter + - grafana - gyliu513 - Hostmetrics + - isovalent + - labs - Liudmila - Nale - REXX @@ -30,6 +36,7 @@ words: - afrittoli - alanwest - alevenberg + - alexvanboxel - alolita - amye - andré @@ -100,12 +107,14 @@ words: - juraci - kamphaus - kanzhelev + - kelnage - keptn - krzko - kröhling - kubecon - kuisathaverat - lalitb + - lambdanis - liatrio - lightstep - lmolkova @@ -118,8 +127,10 @@ words: - mateuszrzeszutek - mayur - mayurkale + - mdelfabro - mhausenblas - mirabella + - mjwolf - molkova - msomasu - mtwo @@ -150,6 +161,7 @@ words: - proto - pyohannes - pytest + - raesene - reiley - reyang - rrschulze @@ -196,6 +208,7 @@ words: - trendable - triager - triagers + - trisch-me - tsloughter - tylerbenson - xibz diff --git a/.github/ISSUE_TEMPLATE/membership.md b/.github/ISSUE_TEMPLATE/membership.md index ca6f4468f..7afdf9d45 100644 --- a/.github/ISSUE_TEMPLATE/membership.md +++ b/.github/ISSUE_TEMPLATE/membership.md @@ -37,4 +37,5 @@ Please remember, it is an applicant's responsibility to get their sponsors' conf - PRs reviewed / authored - Issues responded to +- Community activities I organized/ran - SIG projects I am involved with diff --git a/README.md b/README.md index 354b8dd8b..2d70357bf 100644 --- a/README.md +++ b/README.md @@ -171,7 +171,7 @@ SIG-specific GitHub discussions. | eBPF | Every week on Tuesday at 09:00 PT | [Google Doc](https://docs.google.com/document/d/13GK915hdDQ9sUYzUIWi4pOfJK68EE935ugutUgL3yOw) | [#otel-ebpf](https://cloud-native.slack.com/archives/C02AB15583A) | [calendar-ebpf](https://groups.google.com/a/opentelemetry.io/g/calendar-ebpf) | [Ted Young](https://github.com/tedsuo) | | Client Instrumentation | Every Tuesday at 9:00 AM PT | [Google Doc](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w) | [#otel-client-side-telemetry](https://cloud-native.slack.com/archives/C0239SYARD2) | [calendar-client-side](https://groups.google.com/a/opentelemetry.io/g/calendar-client-side) | [Daniel Gomez Blanco](https://github.com/danielgblanco) | | Kubernetes Operator | Every other week on Thursday at 09:00 PT | [Google Doc](https://docs.google.com/document/d/1Unbs2qp_j5kp8FfL_lRH-ld7i5EOQpsq0I4djkOOSL4) | [#otel-operator](https://cloud-native.slack.com/archives/C033BJ8BASU) | [calendar-k8s-operator](https://groups.google.com/a/opentelemetry.io/g/calendar-k8s-operator) | [Juraci Paixão Kröhling](https://github.com/jpkrohling) | -| Community Demo Application | Every Wednesday at 8:00 PT | [Google Doc](https://docs.google.com/document/d/16f-JOjKzLgWxULRxY8TmpM_FjlI1sthvKurnqFz9x98) | [#otel-community-demo](https://cloud-native.slack.com/archives/C03B4CWV4DA) | [calendar-demo-app](https://groups.google.com/a/opentelemetry.io/g/calendar-demo-app) | [Austin Parker](https://github.com/austinlparker) | +| Community Demo Application | Every other week on Wednesday at 8:00 PT | [Google Doc](https://docs.google.com/document/d/16f-JOjKzLgWxULRxY8TmpM_FjlI1sthvKurnqFz9x98) | [#otel-community-demo](https://cloud-native.slack.com/archives/C03B4CWV4DA) | [calendar-demo-app](https://groups.google.com/a/opentelemetry.io/g/calendar-demo-app) | [Austin Parker](https://github.com/austinlparker) | ## Related groups diff --git a/areas-of-interest.md b/areas-of-interest.md index 75f207972..6628e3485 100644 --- a/areas-of-interest.md +++ b/areas-of-interest.md @@ -75,10 +75,11 @@ concerns. ### [Tigran Najaryan](https://github.com/tigrannajaryan), Splunk -- OpenTelemetry collector - OpenTelemetry protocol - OpenTelemetry schemas and versioning - Logging API and SDK +- Entities +- OpAMP ### [Yuri Shkuro](https://github.com/yurishkuro), Meta @@ -93,11 +94,11 @@ Maintainers and approvers are invited to list their areas of interest to further assist the community in finding appropriate points of contact. -### [Alex Boten](https://github.com/codeboten), Lightstep +### [Alex Boten](https://github.com/codeboten), Honeycomb -- OpenTelemetry Python - OpenTelemetry Collector -- OTel-Lambda support +- OpenTelemetry Python +- SDK configuration ### [Daniel Dyla](https://github.com/dyladan), Dynatrace @@ -108,11 +109,17 @@ contact. ### [Dan Jaglowski](https://github.com/djaglowski), observIQ -- OpenTelemetry log collection -- Logging API and SDK -- OpenTelemetry metric scrapers -- Semantic conventions -- Open Agent Management Protocol +- OpenTelemetry collector +- Log data model +- Traditional log ingestion +- Telemetry processing + +### [Juraci Paixão Kröhling](https://github.com/jpkrohling), Grafana Labs + +- OpenTelemetry Collector +- Distributed tracing +- Security +- Sampling ### [Tom Tan](https://github.com/ThomsonTan), Microsoft diff --git a/community-membership.md b/community-membership.md index 5ee95fe90..3475c6adc 100644 --- a/community-membership.md +++ b/community-membership.md @@ -49,6 +49,7 @@ Defined by: Member of the OpenTelemetry GitHub organization may include, but is not limited to: - Authoring or reviewing PRs on GitHub - Filing or commenting on issues on GitHub + - Organizing and running activities (e.g. events, surveys) within the OpenTelemetry community - Contributing to SIGs, subprojects, or community discussions (e.g. meetings, chat, email, and discussion forums) - [Joined the Slack channel](https://cloud-native.slack.com/archives/CJFCJHG4Q) diff --git a/docs/how-to-handle-public-calendar.md b/docs/how-to-handle-public-calendar.md index b8546342a..c134e5a9d 100644 --- a/docs/how-to-handle-public-calendar.md +++ b/docs/how-to-handle-public-calendar.md @@ -63,6 +63,15 @@ A single Zoom account should not be used for back-to-back meetings or for more t You can see which Zoom account any potentially conflicting meetings are using in the meeting descriptions. (Note: posting the URLs publicly on GitHub leads to Zoom bombing by random bots). +#### Zoom link generation process +_This is the process that the person responding to Zoom link creation issues will follow. The instructions under this heading are for project admins (Governance Committee members) who have access to OpenTelemetry's Zoom account credentials._ + +1. View the OpenTelemetry meeting calendar, and find your desired time slot, along with the meetings that occur immediately before, during, and after it. +2. See which OpenTelemetry Zoom accounts are being used for the meetings immediately before, during, and after your desired time. The Zoom account name / number is typically listed in the description of each meeting; if it isn't, you can join a meeting (even if it isn't occurring now), click on the green shield icon in the top left, and see the account name / number in the 'host' field. +3. Choose a Zoom account that isn't already being used for one of the meetings immediately before, during, or after your desired time slot. You may also choose a Zoom account that is being used *exactly* once immediately before, during, or after (we can run a maximum of two concurrent meetings with each account). +4. Log into that Zoom account, click "Schedule a meeting", and create a recurring meeting with the desired meeting name and no fixed schedule. +5. Copy the newly generated unique Zoom link and paste it into the calendar event's description and location. + ### Inviting attendees All meetings should invite a publicly joinable google group `calendar-...@opentelemetry.io` which is specific to the meeting series. The google group should be set up as follows: diff --git a/projects/security-semconv.md b/projects/security-semconv.md new file mode 100644 index 000000000..a9b212349 --- /dev/null +++ b/projects/security-semconv.md @@ -0,0 +1,83 @@ +# Security Semantic Conventions + +## Description + +The purpose of this project is to bring in the security domain for the OpenTelemetry community. + +As outlined in the [ECS OTEP](https://github.com/open-telemetry/oteps/blob/main/text/0199-support-elastic-common-schema-in-opentelemetry.md), the Elastic Common Schema (ECS) is currently being contributed to the semantic conventions schema. Given the significance of security within ECS, establishing this SIG is crucial as it will expedite the donation of ECS fields tailored to security use cases. Beyond expanding the schema, our aim is to craft a clear vision for the instrumentation required. + +## Deliverables + +* Our current focus is on defining essential semantic conventions for security use cases. + * This includes but is not limited to the following namespaces: + * [`Code signature`](https://www.elastic.co/guide/en/ecs/current/ecs-code_signature.html) + * [`DLL`](https://www.elastic.co/guide/en/ecs/current/ecs-dll.html) + * [`DNS`](https://www.elastic.co/guide/en/ecs/current/ecs-dns.html) + * [`File`](https://www.elastic.co/guide/en/ecs/current/ecs-file.html) + * [`Group`](https://www.elastic.co/guide/en/ecs/current/ecs-group.html) + * [`Hash`](https://www.elastic.co/guide/en/ecs/current/ecs-hash.html) + * [`Host`](https://www.elastic.co/guide/en/ecs/current/ecs-host.html) + * [`Network`](https://www.elastic.co/guide/en/ecs/current/ecs-network.html) + * [`Operating System`](https://www.elastic.co/guide/en/ecs/current/ecs-os.html) + * [`Package`](https://www.elastic.co/guide/en/ecs/current/ecs-package.html) + * [`Process`](https://www.elastic.co/guide/en/ecs/current/ecs-process.html) + * [`Registry`](https://www.elastic.co/guide/en/ecs/current/ecs-registry.html) + * [`Risk information`](https://www.elastic.co/guide/en/ecs/current/ecs-risk.html) + * [`Rule`](https://www.elastic.co/guide/en/ecs/current/ecs-rule.html) + * [`Threat`](https://www.elastic.co/guide/en/ecs/current/ecs-threat.html) + * [`TLS`](https://www.elastic.co/guide/en/ecs/current/ecs-tls.html) + * [`User`](https://www.elastic.co/guide/en/ecs/current/ecs-user.html) + * [`Vulnerability`](https://www.elastic.co/guide/en/ecs/current/ecs-vulnerability.html) + * Please note that some of the above-mentioned namespaces are already a part of the Semantic Conventions schema. The goal is to expand these namespaces to include additional fields that are relevant to security use cases. + +* As new use cases and namespaces are introduced to the semantic conventions, there may be a need for additional instrumentation to accommodate them. It is anticipated that this aspect will expand through an iterative process. + +## Staffing / Help Wanted + +We are seeking security experts to collaborate with us in expanding the security domain within the community. + +### Required staffing + +There is an open [PR](https://github.com/open-telemetry/semantic-conventions/issues/580) to create a `semconv-security-approver` group for all PRs related to security fields. + +* project lead: @trisch-me (Elastic) +* domain expert: @mjwolf (Elastic) +* domain expert: @raesene (Datadog) +* domain expert: @lambdanis (Isovalent) +* domain expert: @mdelfabro (Dynatrace) +* domain expert: @kelnage (Grafana Labs) +* domain expert: @alexvanboxel (Collibra) + +* TC sponsor: @reyang +* TC sponsor: @jsuereth + +Need more +- [ ] domain experts +- [ ] potentially, maintainers of language-specific instrumentation may be needed if the need arises. + + +## Meeting Times + +There is an allocated time in the Semantic Conventions SIG for this project. +- Mondays at 8 AM PST + +For async conversation please use #otel-semconv-security slack channel from official CNCF slack workspace. + +## Timeline + +The goal is to have the security semantic conventions implemented by the end of 2024. + +The timeline for this project is as follows: +December 2023: Initial Draft +April 2024: Review and Refinement +May 2024-December 2024: Introducing the Security Semantic Conventions + + +## Labels + +* security + +## Linked Issues and PRs + +* [Donating ECS to OpenTelemetry](https://github.com/open-telemetry/oteps/blob/main/text/0199-support-elastic-common-schema-in-opentelemetry.md) +* [Creation of semconv-security-approver group](https://github.com/open-telemetry/semantic-conventions/issues/580) diff --git a/working-groups/end-user/README.md b/working-groups/end-user/README.md deleted file mode 100644 index 94273b348..000000000 --- a/working-groups/end-user/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# OpenTelemetry Icon OpenTelemetry End User Working Group content - - -## What is the End User Working Group? - -There are two primary goals of the End User Working Group: -* Foster a sense of vendor-agnostic community for OpenTelemetry end-users to promote learning and adoption. We currently accomplish this through: Organization and facilitation of End User Discussion Group & Administration of a private end-user discussion slack channel. -* Facilitate the collection and communication of end-user feedback to OpenTelemetry project special interest groups to influence SIG priorities. We currently accomplish this through: Creation and maintenance of end-user research assets such as OpenTelemetry Community surveys & Organization and facilitation of structured end-user interview sessions. - -Our group discourages promotion of vendor-specific solutions and desires to keep the focus on OpenTelemetry core technologies, adoption and usage. - -## Get Involved - -There are many ways to get involved in our work! We (End User Working Group) meet every two weeks on Thursdays at 10:00 AM PST. Check out the [OpenTelemetry community calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com) -for the Zoom link and any updates to this schedule. - -Meeting notes are available as a [public Google doc](https://docs.google.com/document/d/1e-UNZA3Tuno9b53RQbe--whUcO0VIXF3P81oXsrBK6g). If you have trouble accessing the doc, please get in touch on [Slack](https://cloud-native.slack.com/archives/C01RT3MSWGZ). - -As an end user, you may want to: - -* Reach out to us to tell us your OpenTelemetry adoption story. You can reach out in [#otel-user-research](https://cloud-native.slack.com/archives/C01RT3MSWGZ) to learn more. -* Take one of our surveys, like our [OpenTelemetry Quarterly Feedback Survey](https://docs.google.com/forms/d/e/1FAIpQLSdKm6oLYRXlZOhEZMVmjoIn4eBToVYNmF6fwpm5GAIipQmPxA/viewform?pli=1) -* Participate in end-user discussions asynchronously on Slack or synchronously via Google Meet. -* Follow this page and [#opentelemetry](https://cloud-native.slack.com/archives/CJFCJHG4Q) to learn about new engagement opportunities as we grow our efforts. -* Encourage other end-users to join and get involved! - - -As someone interested in user research and/or improving the user experience of OpenTelemetry, you may want to: - -* Attend the [Working Group meetings](https://docs.google.com/document/d/1e-UNZA3Tuno9b53RQbe--whUcO0VIXF3P81oXsrBK6g) and contribute to our efforts. -* Become an end-user interview facilitator or helper. -* Follow our work coordination efforts in [#otel-user-research](https://cloud-native.slack.com/archives/C01RT3MSWGZ). -* Amplify the existence of our surveys and end-user engagement opportunities to interested people! - -## Communication -We coordinate our working group efforts in [#otel-user-research](https://cloud-native.slack.com/archives/C01RT3MSWGZ) on CNCF Slack. - -If you are new, you can create a CNCF Slack account [here](https://slack.cncf.io/). - - diff --git a/working-groups/end-user/discussion-group-code-of-conduct.md b/working-groups/end-user/discussion-group-code-of-conduct.md deleted file mode 100644 index a85eb7394..000000000 --- a/working-groups/end-user/discussion-group-code-of-conduct.md +++ /dev/null @@ -1,27 +0,0 @@ -# #OTel-EndUsers Code of Conduct - -The OpenTelemetry End User Discussion Group is an online Slack based community dedicated to sharing best practices and discussing the usage of OpenTelemetry. - -All participants in the channel are required to comply with the [CNCF code of conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md) which outlines expectations for acceptable behavior. - -We expect all channel members to follow [Chatham House Rule](https://www.chathamhouse.org/about-us/chatham-house-rule) while engaging in this channel. You are free to use the information in this slack channel in other contexts, however you should not disclose the identity or affiliation of any commenter in this channel. - -Please refrain from sharing information that you or your employer would consider sensitive. While we expect all members to honor confidentiality of this channel, we can not guarantee they will comply with expectations. Slack is not a confidential communication space. - -If you violate this code of conduct, you will be removed from the channel. - -Enforcement of this code of conduct is administered by: Reese Lee and Rynn Mancuso - -If you no longer agree to this code of conduct, please remove yourself from the channel immediately. - - -# FAQs: - -Q: Why isn't the end-user channel a public channel? - -A: So that we can enforce Chatham House Rule. - - -Q: I agree with this code of Conduct, how do I get an invite? - -A: Reach out to Reese Lee or Rynn Mancuso for an invite. diff --git a/working-groups/end-user/discussion-group-facilitation.md b/working-groups/end-user/discussion-group-facilitation.md deleted file mode 100644 index 0cff548d9..000000000 --- a/working-groups/end-user/discussion-group-facilitation.md +++ /dev/null @@ -1,38 +0,0 @@ -# OpenTelemetry Icon OpenTelemetry Discussion Group Facilitation Guidance - - -We use a Lean Coffee format to help facilitate effective community discussions. This style is great for lightly structured groups because participants have full influence over the topics they most want to engage with and through the use of timeboxing, it helps ensure that no one person or one topic dominates the discussion. - -If you haven’t heard of lean coffee, this is a nice high level introduction: https://leancoffee.org/ - -To help with facilitation structure, the best practice is to use a tool for topic generation and voting. One of the best tools I’ve encountered for this use case is [agile.coffee](http://agile.coffee/). You can make a board each session or you can re-use the same board from prior discussion groups (if you choose to reuse, don’t forget to delete the prior topic cards!). I suggest configuring the board to allow for 3 or 4 votes per person (general guidance is the larger the group, the more votes to allocate per person). Screen sharing the facilitation tool helps late arrivals acclimate to the group and participate more quickly. - -### As facilitator of a discussion group, your role is to: - -#### 1. Verbally set the stage, welcome the group and reiterate the following points: -- Group discussions are held under [Chatham House Rule](https://www.chathamhouse.org/about-us/chatham-house-rule). Briefly explain that Chatham House Rule is “You are free to use the information or stories you learn today in the discussion group but you CAN NOT share the identity of any participants or the company they are associated with.” -- Communicate that the discussion group will not be recorded -- If there are vendor spectators in the audience, set expectations that this is not a lead generation event and if that’s their intention they need to drop off the call. Remind everyone that lead generation is a direct violation of Chatham House Rule. -- Give a ~90 second introduction to lean coffee for new attendees. - - Review what action you need from participants (proposing topics and voting on topics). - - Remind folks that the agile.coffee board contents could be discoverable and not to add information they or their employer might consider sensitive. -#### 2. Prepare the topic backlog: -- In chat, send a link to the agile.coffee board and ask people to add in topics they would like to discuss. -- Timebox topic generation to about 2-3 minutes, allowing for more time in the event there are still multiple new proposed topics coming in. -- After topics are all submitted, de-duplicate, or merge as appropriate. In agile.coffee you can drag and drop topic cards to merge. -- Ask people to vote on topics they’d most like to discuss. Set aside about 60 seconds for voting. Remind the audience they can spend all their votes on one topic, or they can spread their votes out among multiple topics. Agile.coffee should automatically stack rank topics according to vote count. -#### 3. Kick off the discussion, keep time and burn down the topic backlog: -- Remind folks you’re putting 4-5 minutes of time on the clock and in agile.coffee, pull the most voted on topic card into the “currently discussing” column. -- Ask whoever wrote the current topic to kick off the discussion, perhaps by providing more context or elaborating on the topic item. -- When the countdown expires, let the current speaker wrap up their line of thinking or cut them off gently. -- Solicit a vote to continue discussing the current topic or move to the next topic. Use your best judgment. If the vote is to continue with the current topic, add 2-3 minutes to the timer and repeat steps c & d until the vote is to move onto the next topic. -- Don’t forget to move the topic through the “currently discussing” and into the “done discussing” column. Then repeat step 3 until all topics have been discussed or not enough time remains to start a new topic. -#### 4. Close the discussion group: -- Show appreciation for participation and engagement. -- Ask the participants to provide feedback on the discussion group in the chat window before they log off. Good questions include: ---Would they recommend this group to a friend or colleague? ---What is one thing they’d like to see changed for the next discussion group. -#### 5. Report back to the community: -- After the discussion group concludes, please report back to [#otel-user-research](https://cloud-native.slack.com/archives/C01RT3MSWGZ) and share the topics discussed, the number of attendees, the rough number of active participants and any feedback you received. The end user working group appreciates visibility into current interests of end users. - -If you are interested in practicing your discussion group meeting facilitation skills, we’d love to have your help. Please reach out about facilitation opportunities in [#otel-user-research](https://cloud-native.slack.com/archives/C01RT3MSWGZ). diff --git a/working-groups/end-user/discussion-group.md b/working-groups/end-user/discussion-group.md deleted file mode 100644 index 502869bfb..000000000 --- a/working-groups/end-user/discussion-group.md +++ /dev/null @@ -1,37 +0,0 @@ -# OpenTelemetry Icon OpenTelemetry End User Discussion Group - -## What this discussion group is: -Members of the OpenTelemetry End User working group facilitate monthly discussion groups to bring together operations and development engineers from different organizations to discuss challenges and solutions to achieving ubiquitous observability. This vendor neutral event provides space for end users to share successes and failures, discover best practices, and meet others who are also on a journey to implement observability powered by OpenTelemetry. - - -This group is what its participants make it--whatever is of interest to the group is fair game! But here are some of the kinds of topics we expect will be on the table: -- Refactoring with telemetry -- What is company X doing with OpenTelemetry? -- Correlating multiple observability signals -- Maintaining and scaling OpenTelemetry deployments -- Writing custom instrumentation - -### What this discussion group is not: - -The OpenTelemetry community is constantly evolving and is composed of vendors, adopting organizations and independent contributors. There may be vendor spectators in the audience, however this group is not an event where collecting leads will be tolerated because that’s a direct violation of Chatham House Rule. - -## How to participate: -These discussion groups occur on a monthly basis in AMER and EMEA friendly timezones, and creation of an APAC friendly timezone group is in the planning stages. You can see these events on the [community calendar](https://calendar.google.com/calendar/embed?src=google.com_b79e3e90j7bbsa2n2p5an5lf60%40group.calendar.google.com) by searching for “discussion group.” - -## What to expect: -The format of the discussion groups should evolve over time to provide the best experience for participants. In the meantime, the format of the discussion groups is [Lean Coffee style](https://leancoffee.org/), where discussion topics are generated and democratically selected by the group at the start of the meeting. Then topics are rigorously time-boxed by a facilitator to keep the discussion moving forward. - -Because it can be a bit intimidating to talk to strangers, especially when talking about challenges, discussion groups are held under [Chatham House Rule](https://www.chathamhouse.org/about-us/chatham-house-rule). This means you are free to use the information or stories you learned in the discussion group but you CAN NOT share the identity of any participants or the company they are associated with. Discussion groups are not recorded. - - - -## FAQ: - -Q: Is this group only for OpenTelemetry end users? - -A: No! Anyone is welcome to join and discuss their journey to observability. This group is hosted by the OpenTelemetry Community End-User Working Group, so we expect most participants will be from organizations that are evaluating or using OpenTelemetry. - -Q: I have questions about this, who can I reach out to? - -A: You can find members and discussion group facilitators in the End User Working Group in CNCF slack channel [#otel-user-research](https://cloud-native.slack.com/archives/C01RT3MSWGZ). - diff --git a/working-groups/end-user/end-user-interviews/README.md b/working-groups/end-user/end-user-interviews/README.md deleted file mode 100644 index 8c12cb442..000000000 --- a/working-groups/end-user/end-user-interviews/README.md +++ /dev/null @@ -1,35 +0,0 @@ -# OpenTelemetry Icon OpenTelemetry community End User interview FAQ - -## What are end user interviews? - -- The OpenTelemetry community conducts end user interviews to gather high fidelity information from users though the medium of synchronous discussions to learn about their challenges, preferences, and behaviors regarding OpenTelemetry. - -## Why do these interviews happen? - -- Many vendors in this space conduct interviews with their customers but that feedback doesn't always make its way back to the community directly. These interviews will help us test our assumptions, categorize end-users, and describe their needs so that the community can react to their feedback. - -## When do these sessions happen? -- Our end user working group goal is to hold at least one session a month. -- Our scheduling preference is for these sessions to occur at 10:00 AM PST on Thursdays, however the final schedule will be dictated by the end-user interviewee’s availability. - -## Are the interview sessions recorded? -- Sessions are only recorded if the end user is comfortable with them being recorded. In this directory, you can find links to both video recordings and session summaries created by the Facilitator and Helper roles, as appropriate. - -## What are the end user interview roles? - -* ### Interview Facilitator: - Required - - The interview facilitator is a named role for each session and is responsible for the end-to-end control of the interview. The facilitator identifies end-users, confirms their availability and schedules the interview. The facilitator can ask questions themselves and lead the interview, or they can delegate the flow of the discussion to another named person. If there is a known agenda/area of feedback the facilitator communicates this to the end-user to prepare them for a successful session. The facilitator follows up post-interview with a note of appreciation for the end-users participation. - -* ### End-user Interviewee: - Required - - The end-user interviewee communicates their preference on scheduling and session duration. The end-user attends and shares feedback and stories about their experience with OpenTelemetry. - - Interviewee selection criteria vary and change depending on the needs of the community. Some example criteria includes “people who have used OTel before”, “people who have implemented monitoring, telemetry, observability either in code or in platforms”, “people who develop software and don’t feel they have enough information about how it works in environments other than their laptop” - -* ### OTel Community Helper: - Required - - The OTel community helper is a named role for each session. The community helper will complete coordination and amplification tasks such as tracking session recording links, acting as note keeper, and publishing up an interview summary. The community helper can also be the same person as the interview facilitator. - -* ### OTel Community member audience: - Optional - - Members from the OTel community are welcome to observe the interview and coordinate with the facilitator if there are any specific topics they’d like to be included during the interview. - -## How can I get involved or learn more? -- Are you interested in providing the community your feedback in this way? Please contact us in [#otel-user-research](https://cloud-native.slack.com/archives/C01RT3MSWGZ) on CNCF Slack to talk about scheduling. And as always, you can provide your feedback to the community in many ways including our community surveys too. -- Are you someone who is passionate about gathering and sharing end user feedback? Would you like to help us conduct interviews, improve how we solicit feedback or design a more robust end user interview program? If so, we'd love to hear from you too! We are a friendly, collaborative group and look forward to working together! diff --git a/working-groups/end-user/end-user-interviews/end-user-interview-outcomes/README.md b/working-groups/end-user/end-user-interviews/end-user-interview-outcomes/README.md deleted file mode 100644 index 88c1a6ced..000000000 --- a/working-groups/end-user/end-user-interviews/end-user-interview-outcomes/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# OpenTelemetry Icon OpenTelemetry Historical end user interview resources - -This serves to transparently organize our interview activities and findings - -### August 2022: n/a -- Summer break! - -### July 2022: Shopify -- Recording Link: https://www.youtube.com/watch?v=AZJT4LHdygU -- Summary: [not currently available] - -### June 2022: Anonymous technology development platform company -- Recording link: n/a -- [Summary](june-2022-techdevplatform.md) \ No newline at end of file diff --git a/working-groups/end-user/end-user-interviews/end-user-interview-outcomes/june-2022-techdevplatform.md b/working-groups/end-user/end-user-interviews/end-user-interview-outcomes/june-2022-techdevplatform.md deleted file mode 100644 index 0085e3a0c..000000000 --- a/working-groups/end-user/end-user-interviews/end-user-interview-outcomes/june-2022-techdevplatform.md +++ /dev/null @@ -1,52 +0,0 @@ -# OpenTelemetry Icon June 2022 End User Interview -## Who: -- An engineer on a technology development platform centralized observability team *and* OpenTelemetry project SDK maintainer. - -## Stack/What they’re trying to Observe: -- C -- C# -- C++ -- Go -- Java -- JavaScript (TypeScript, Node.JS) -- .NET Core -- Python -- Ruby -- Rust - -They also want to observe Kafka (subscriber model) - -The company heavily uses logs and Statsd. - -They want to instrument their Hosted SaaS & On Prem offerings. - - -## Their end vision for OTel: -They are focused for the moment in Tracing. They want to report traces that increase the efficiency of production tasks. -Instrumentation goals deal with operational matters, does not include business intelligence use cases. - -## Why OTel: -Create a better experience for engineers, support staff and customers. -Want to enable their customers to have a “bring your own telemetry offering.” The company wants to rely on OTel to give the choice to their own customers on where they want to export the telemetry from their platform. - -## Challenges: -1. Getting engineers on other teams bootstrapped to use OpenTelemetry - - Their team has created some install guides and opinionated setups, but this takes time and is not complete. - - The ergonomics for adding span attributes are a challenge in some languages and not generally consistent - - Specific Ask: There are reasonable configuration defaults, but not every language does it the same way. - - The centralized observability team commonly reviews PRs from other teams so they can provide feedback before merge which help enforce rules and control costs -- Documentation is confusing and overwhelming - - Specific Ask: Create a consistent voice in the documentation. - - The company contributes upstream to project documentation -2. Maturity of auto-instrumentation - - Things don’t work ‘magically’ for other team developers; this is a different experience than most developers have had with commercial solutions. -3. Maturity of semantic conventions is hindering enthusiasm and wide internal adoption -They’re defining internal semantic conventions - -## Positive notes: -A recent expansion which includes node.js and rust components has recently gone to production and: “so far so great” - -## Notes of Interest: -- Their usage of the collector is minimal, running a PoC now. They would like to get recommendations on the right sizing for the collector. Requires managing the authentication layer with their proxy to make it work. -- They have an internal distribution of Ruby OTel. -- Their company is very logs focused; tracing is not widely adopted. A logs focus has affected how they adopt the project considering the emerging maturity of logs. diff --git a/working-groups/end-user/end-user-interviews/end-user-interview-process.md b/working-groups/end-user/end-user-interviews/end-user-interview-process.md deleted file mode 100644 index be3f671d6..000000000 --- a/working-groups/end-user/end-user-interviews/end-user-interview-process.md +++ /dev/null @@ -1,41 +0,0 @@ -# OpenTelemetry Icon OpenTelemetry community Interview Discussion Guide - - This template outlines a best practice flow for for end user interviews. This guidance might be especially helpful if there is no pre-defined session agenda. - -Suggested Interview Flow (30/60 minute duration) - -## Housekeeping (~5 min) -- [ ] Welcome the end user and thank them for participating. -- [ ] Confirm it’s ok to record the interview. [Start Recording if not auto-enabled] -- [ ] Outline the expected flow for the interview, highlighting any special topics and that there will be time for the audience and the end-user to ask questions too. -- [ ] Introduce yourself and ask them to introduce themselves (and the audience too if time allows) - -## Warm-up questions (~3 / 10 min) -This section helps set the stage for the session and provides context that should allow for more insightful questions to be asked later. -- Please tell us about your role in the company. -- What are the top 3 problems that you’re now facing in your role? -- Can you describe your architecture, programming languages that your organization uses, and deployment environment? How do you deploy applications today? -- How are the apps/services that you work with currently instrumented and/or logged? -- What telemetry are you capturing, and where are you sending it? -- How do you interact with telemetry coming from apps/services in your org? If not, who? -- Are you using vendor-specific telemetry instrumentation? If so, why? - -## Meaty questions (~15 / 25 min) -This section will depend upon goals for the interview and what assumptions and/or hypothesis is being tested, some suggested questions are below: -- What [would] prevents you from implementing [better] telemetry? -- Who else is also involved in improving your telemetry landscape? -- Are you interested in contributing to this project/community, if so what challenges do you have with that? - -## [Optional] Observer questions (~0 / 5 min) -- Ask the audience if they have any questions for the end user - -## Turn the tables (~5 / 10 min) -- [ ] Ask the end user what questions, if any, you or the folks on the call can answer for them - -## Wrap it up (~3 min) -- [ ] Thank the end user for their time - - - ----- -This guidance was heavily inspired by and adapted from Atlassian's Customer Interview Teams Playbook found here: https://www.atlassian.com/team-playbook/plays/customer-interview \ No newline at end of file diff --git a/working-groups/end-user/end-user-surveys/README.md b/working-groups/end-user/end-user-surveys/README.md deleted file mode 100644 index 5f168cb2e..000000000 --- a/working-groups/end-user/end-user-surveys/README.md +++ /dev/null @@ -1,66 +0,0 @@ -# OpenTelemetry Icon OpenTelemetry community surveys -This document is intended to outline best practices for long running and durable OpenTelemetry community surveys. - -The OpenTelemetry community would like to gather data about end-users including their experiences, preferences, perceptions and opinions about OpenTelemetry. This data can be used to inform priorities within various OpenTelemetry projects. - -# Active Surveys: -1: [OpenTelemetry Quarterly Feedback Survey](https://docs.google.com/forms/d/e/1FAIpQLSdKm6oLYRXlZOhEZMVmjoIn4eBToVYNmF6fwpm5GAIipQmPxA/viewform?pli=1) - -- Intent: Gather quantitative data on our end-user community through a simple periodic survey that provides insight with established long running Key Results that we can trend over time. Recruit end-users for future qualitative studies and surveys -- Survey owners: @sharrmander and @henrikrexed -- Duration: This survey will be available in perpetuity with some intentional advertising/pushing once a quarter to submit feedback. -- Distribution: Survey Results will be summarized on a quarterly basis -- [Anonymized raw quarterly feedback survey results](https://docs.google.com/spreadsheets/d/1j2jFe9LLuhJS-NX2xy78ugMo5gDeG-zZeQLOTsgUDTw/edit#gid=0) - -# Community survey best practices - -### Community survey principles -- User feedback should be a mix of qualitative and quantitative: - - Qualitative to validate/invalidate hypotheses - - Quantitative to set a baseline for key results and segment customers -- All user feedback will be collected anonymously except direct customer interviews -- Raw data should be transparent to the community/world -- The end user working group will reach consensus on key milestones, including: - - Recurring/perpetual survey design - - Survey Hypotheses - - Measuring Key Results - - Survey Best Practices - - Summarizing and reporting results - -### Recognized Survey Types: -1. Direct Survey (anonymous) - - OpenTelemetry end user submits survey form - -2. Vendor-mediated Customer Interview (semi-anonymous) - - Vendor interviews customer & then submits survey form on end-user’s behalf - -### Survey reminders: -- Be respectful of the survey-takers' time, in general try to keep the survey short in duration, with specific and targeted questions. You can always ask if you can follow up with them to get deeper context. -- We want to measure improvements too, so using trendable questions helps us assess how we’re doing -- We encourage mix of general and targeted surveys - -### Helpful questions and considerations: - -- Audience identification: - - Who will participate in the survey? What is their user role? - - Do you need any segmentation or demographic information to meet your survey goals? - - How many participants do you need for success? -- Establish Survey Intent & Goals: - - What are you looking to learn/identify/measure? - - How will the data be used? - - What are the survey Key Results? -- Crafting Survey Questions: - - What is the problem/feedback you want to gather data on? - - Should you be looking for quantitative or qualitative information, or both? -- Distribution Channels: - - Where will the survey be advertised? - - How will end-users be invited to participate? -- How do you plan to analyze & distribute the survey responses: - - How will the data be reported? - - What can be summarized? - - Do you have any conclusions, insights or recommendations? - -Survey best practices resources were heavily inspired by these resources: - -- [Survey Research Step-by-step Guide](https://www.scribbr.com/methodology/survey-research/) -- [Types of Survey Questions](https://www.smartsurvey.co.uk/survey-questions/types)