Thanks to everyone who has contributed to OpenTelemetry to date, and we +look forward to your continued contributions in 2024 and beyond! 🎉 + +## Transcript + +If reading is more your thing, check out the transcript of our conversations +below. + +### 1- Meet the Humans of OTel + +**IRIS DYRMISHI:** Well, I'm Iris Dyrmishi. I'm a senior observability engineer +at Miro and my life, my professional life is all about observability. I build an +observability platform that provides the tools for engineering teams at Miro to +monitor, to observe and get the best of their applications. + +**SEVERIN NEUMANN:** My name is Severin Neumann. I'm working at Cisco at the +open source program office and I'm a member of the OpenTelemetry governance +committee and I'm one of the co-maintainers of the OpenTelemetry documentation. + +**KAYLA REOPELLE:** My name is Kayla Reopelle. I work for New Relic and I am +contributing to the OpenTelemetry Ruby project. + +**MORGAN MCLEAN:** My name is Morgan McLean,I'm a director of product management +at Splunk.I've been with OpenTelemetry since day one. I'm one of the co-founders +of the project. I'm on the governance committee. Wow. What do I work on within +OTel?A bit of everything. I mean early on it was literally everything. Myself +and Ted and various others were doing many, many jobs. More recently I was +involved in the release of traces, metrics 1.0. Logs 1.0 last year. Right now +I'm working on profiling as well as OpenTelemetry's expansion into mainframe +computing. + +**HENRIK REXED:** My name is Henrik Rexed. I am a cloud native advocate at +Dynatrace and I'm passionate about observability, performance, and I'm trying to +help the community by providing content on getting started on any solutions out +there. + +**VIJAY SAMUEL:** My name is Vijay Samuel and I help do architecture for the +observability platform at eBay. + +**DANIEL GOMEZ BLANCO:** I'm Daniel Gomez Blanco. I'm a principal engineer at +Skyscanner and also member of the OpenTelemetry governance committee. + +**DOUG ODEGAARD:** My name is Doug Odegaard. I'm a senior solutions architect +with ServiceNow Cloud Observability, which is also formerly Lightstep. I'm also +a previous customer of using OpenTelemetry for several years prior to that. + +**ADNAN RAHIĆ:** Hey, I am Adnan. I work at Tracetest as a developer advocate +which is...you can guess better than me what that is. Pretty much do a bunch of +everything regarding OpenTelemetry. I'm one of the contributors for the +documentation, for the blog, and the demo. + +**RYNN MANCUSO:** My name is Rynn Mancuso. I work for Honeycomb.io and I am one +of the maintainers of the End User SIG. + +### 2- What does observability mean to you? + +**IRIS DYRMISHI:** What does observability mean to me? observability to me is +the biggest passion of my life and also my professional career. It is one of +those areas that you are not very interested when you start your career because +you don't know anything about it. It's not taught in school, it's not preached +by the tech communities a lot, but then you discover it and say, "Wow, this is +amazing!" We're actually making a change and we're helping the teams make the +best of their product. So yeah, that's all. + +**SEVERIN NEUMANN:** I think observability is a big game changer, right? So it's +evolution from what we have done, especially APM, over the last few years. So I +worked for a very long time at AppDynamics and we sold APM agents to customers +and we gave them a lot of the things that observability is promising today as +well. But the big change I see with observability that it's coming down, let's +say to everybody, right? So this is making the things that we did there +available for everybody. And even more, we're moving away from this... Hey, +let's add a post compilation agent into your application to like, yeah, let's +make native observability. Let's make this a thing that developers, that +operation teams are using across all the organizations. + +**KAYLA REOPELLE:** So to me observability means having peace of mind. It means +having something that you can rely on in order to see what happened and what +went wrong. I think observability is also a way to feel more technically +connected to your customers and your users, so that you can see the ways that +they're interacting with your software instead of just the ways that you might +interact with it. + +**MORGAN MCLEAN:** I mean, observability to me transcends just the computing +industry. It's the ability to peer into something and understand how it works, +what it's doing right now, and thus if it breaks, how to fix it more quickly. +Certainly when we think about telemetry in this industry, what observability +classically has meant is visibility to backend infrastructure and applications +kind of excitingly, I think it's expanding right now, right? With OpenTelemetry +we're pushing into client applications, we're pushing into mainframes, as I +mentioned earlier. And so it's really visibility into any systems that impact +your business, any technical system observability. + +**HENRIK REXED:** Usually when people mention of observability they say it's a +replacement of the old name monitoring. But in fact for me it's more than +monitoring, because monitoring is like, you just look at something and +observability is like having enough information to understand a given situation. +So if you just look at metrics then, okay, you have a guess that something is +going on, but you don't understand. So having the options to get more +information like logs, events, exceptions, traces, compiling, then at the end +combine all those dimensions together, then you say, okay, I got it, this is my +problem and I can resolve it. + +**VIJAY SAMUEL:** What does observability mean to me? I belong to what is called +the site engineering organization inside of eBay, and our goal is to make sure +that we can observe everything that's going on in the site and ensure that we +have high availability. So basically, observability means knowing if the site is +running fine or not, because that's why I'm there. + +**DANIEL GOMEZ BLANCO:** What does observability mean to me? It's a way for us +to understand what's happening within our systems, because we run quite a +complex system, so we need to understand what goes on inside of them so we can +deliver a good experience for our end users at the end of the day. + +**DOUG ODEGAARD:** So observability is, to me, I've been a full stack developer +for years, and so as we observe...actually I ended up on an incident response +team doing tracking of incidents, but also trying to figure out what was wrong. +And it pointed out to me how much we need this, how hard it was to look at so +many different screens and so forth. + +**ADNAN RAHIĆ:** So observability is, to me, I've been a full stack developer +for years, and so as we observe...actually I ended up on an incident response +team doing tracking of incidents, but also trying to figure out what was wrong. +And it pointed out to me how much we need this, how hard it was to look at so +many different screens and so forth.observability for me is the way to actually +see what's happening in your system. It's the pinnacle of not being up the whole +night trying to figure out what went wrong. And with OpenTelemetry and with the +rise of tracing the last couple of years, it has hit an all time high with +regards to the possibilities that we have right now. So I'm just really, really +happy to be part of the project. I'm also really happy that it's growing at that +pace, that it's growing right now, and I can't see how that's going to evolve +within the next couple of years. + +**RYNN MANCUSO:** For me, observability is about being able to ask deeper +questions of our systems, being able to demand, I think more than just alerting +on things that are emergencies, things we've seen before, but actually being +able to go out into the unknown and understand how complex systems are +performing. + +### 3- What does OpenTelemetry mean to you? + +**IRIS DYRMISHI:** OpenTelemetry is the tool that is making observability great +again. I would say that observability is seeing the surge, now that +OpenTelemetry is becoming so popular, it's allowing centralization of telemetry +signals, it's allowing semantic conventions, and it's generally helping +observability teams and engineering teams take more attention to the +observability and building it and making it better. + +**SEVERIN NEUMANN:** What does OpenTelemetry mean to me? I think it's the +vehicle for observability. It's enabling that. And I joined OpenTelemetry +community a few years back because I was curious about this idea to bring +observability to everybody. And I think we are doing a really good job. And what +it also means to me now is that it's an amazing community. Right? So we're at +KubeCon here, and I meet so many people I just know from those conversations, +and now I can talk to them in person. And we talk a lot about OpenTelemetry, but +we also talk a lot about other things than OpenTelemetry. We talk about +observability, of course, about what we think about is going to happen in a few +years and all those other things, and that's what OpenTelemetry means to me. + +**KAYLA REOPELLE:** So OpenTelemetry to me seems like it's a community effort to +take the best of what's already been out there for instrumentation and collect +it in one group so that everyone can benefit from it. I think that we've learned +so much as different agent engineers, but there's also so much to learn from +users of the products themselves. And OpenTelemetry does a great job of bringing +both people who are, you know, experts in observability, and experts in +languages to make something that's really great and meaningful for everyone. + +**MORGAN MCLEAN:** I mean, OpenTelemetry is my baby. Put so much effort into +creating this project. What does it mean to me? I mean, there's the boring +answer, which is it extracts signals: metrics, traces, logs, profiles, +everything else from your infrastructure, from your services, from your clients, +makes those observable, processable on the backend. But I think to a lot of us +who've been in this community so long, and a lot of us like yourself and Henrik +here and others who participate in the community so much, I mean, OTel is also +just a really nice open source community to participate in. It's a thing I just +enjoy working on. I know that's abstract and kind of like a sort of squishy +thing to say, but I don't know. OTel has a lot of meaning to me in many +different ways. All very positive. + +**HENRIK REXED:** OpenTelemetry for me, means the future. Because at the end, by +having an open standard, we have the luxury to have a common standard for common +format, for all the solution of the market and having that common format for all +the industry and all the vendors and all the solutions, it will just open use +cases. I think testing used to rely on, I don't know, feedback from users. And +now with observability data, we could be so much efficient in the way we're +testing, we could be so much efficient in replacing marketing tools, business +analytics tools. I think it's the future. And one thing that also a lot of +people talk about, AI everywhere, machine learning, blah, blah, blah, but I +think it's the same thing as a Tesla. I mean, Tesla, when you drive your car, it +takes decisions based on the sensors that it measures. And if you don't have +those sensors and those measurements, then you cannot have a smart... you can +have the smartest systems, but without the data, you cannot take the right +decisions. I think it's an enabler also for the future implementations of modern +applications. + +**VIJAY SAMUEL:** OpenTelemetry is the standard for observability going forward, +and it's very important because as we have gone through the journey of +observability over the past few years, we have had to hunt for open standards in +Prometheus and few others. Now, at least with ingestion and collection, it's a +single standard for everyone to adopt. And I think that's pretty powerful for +the long run. + +**DANIEL GOMEZ BLANCO:** What does OpenTelemetry mean to me? That, I think is +bringing people together, bringing everyone together under one single language +and the ones that way of thinking about telemetry. I think human languages are +difficult enough for us to understand each other. And I think, you know, +OpenTelemetry is bringing the technology together and one single way of like, +thinking about telemetry, thinking about how we observe our systems. + +**DOUG ODEGAARD:** To me, OpenTelemetry is bringing the ability to have product +teams, infrastructure teams, helping their jobs make it easier and also just +improve the customer experience and just make it overall a better experience to +do our jobs. + +**ADNAN RAHIĆ:** OpenTelemetry is the, I'm going to say, the future of +observability. We've seen so many companies, many vendors move to an +OpenTelemetry-first mindset, and the way that you can use OpenTelemetry to +generate them, to actually gather all telemetry signals with one set of +libraries, with one tool. It's just the way it was supposed to be. You're not +locked into one tool, one vendor, one cloud provider anymore. You can do +basically whatever you want, and you can use both the metrics, logs, and traces +for basically anything you want to do. Really happy to see it. + +**RYNN MANCUSO:** OpenTelemetry is an instrumentation protocol that helps us ask +more detailed questions about observability because it collects multiple signals +from many flexible types of systems. Folks monitor everything from the control +plane in Kubernetes all the way up to physical on-prem systems. It's a really +flexible language and it's beautiful community of humans that came together over +the pandemic to build something really special. + +### 4- How did you get involved with OpenTelemetry? + +**IRIS DYRMISHI:** I was working in a very fast-pacing observability team, and +we were maintaining a lot of tools and we really did not have conventions there, +we did not have centralizations and we really were not flexible when it came to +backends and vendor agnostic in general. So we discovered this amazing tool +called OpenTelemetry. We said okay, let's give it a try. It worked great for us. +And here I am today, one year later, more than one year later, and let's say +pushing the migration to OpenTelemetry in my second project. + +**SEVERIN NEUMANN:** How did I get involved into OpenTelemetry? So yeah, I +mentioned that... so I got curious a few years ago. So I was... I was at +AppDynamics working as a so-called domain architect, and I was an expert for +Node.js, Python and a lot of those other languages. And there was always this +conversation around like, hey, there's this thing now called OpenTelemetry and +should we not integrate this into our product? And I was like, okay, I want to +learn more. Then I was like, what is a good way to learn something new about an +open source technology? Yeah, get involved into that. So I was involved in +JavaScript at some point, and then at some point I realized like, yeah, but if I +really want to get a good view into OpenTelemetry, doing documentation is a good +way into that. And that's how I ended up being a maintainer for the +documentation. + +**KAYLA REOPELLE:** I got involved in OpenTelemetry last spring when New Relic +asked me to take a look at what the current status was of the OpenTelemetry Ruby +project. I also work as an engineer on the New Relic Ruby agent team, and that +gave me an opportunity to start to contribute to the project. And I noticed that +a lot of the signals for Ruby weren't yet stable. So a lot of my work so far has +been going into trying to bring logs and metrics to stability in Ruby. + +**MORGAN MCLEAN:** I was working at Google on Google's observability products +like tracing, profiling, debugging, that sort of thing. And one of the +challenges we had in tracing was getting data from people's applications. It's +really, really hard. You need integrations of hundreds of thousands of pieces of +software. No one team, no one company is going to maintain that. It's just +infeasible. And so we want to do something open source. There were other open +source standards. There was one that had started, I think, roughly around the +same time we were doing this, called OpenTracing. We started OpenCensus. + +At some point, especially amongst the more social media savvy members, the team, +which I am not one of, there was some contention between those projects about +where people who maintain databases and language runtime things should actually +spend their integration efforts, and it was limiting the success of both +projects. So I was leading OpenCensus. Ted and Dan and others were leading +OpenTracing. And in late 2018, early 2019, we finally sort of brought things to +a head and decided to merge those into what is now called OpenTelemetry. So +that's sort of, you know, I've been involved since then, I've been...now I work +at Splunk. Different company, but still on the same types of things. But that's +how my involvement started, and it's just grown and grown and snowballed from +there. + +**HENRIK REXED:** When I started the adventure in observability, of course, I +joined Dynatrace, and Dynatrace has their vendor agent, the OneAgent, and I saw +this movement of OpenTelemetry, and coming from the performance background, I +looked at it and I said, "Whoa, an open standard." "That sounds quite exciting" +because I had a performance, a gig for a customer, where I implemented like a +collecting logs and processing it and putting machine learning. And I told +myself at that time, it would be so wonderful to have one common standard. So +then instead of doing a custom implementation, I could have something for +everyone. And when I looked at the, just the definition of the project and the +things behind the project, I was so excited. I said, oh, gosh, I want to be +involved in the project. And that's where I started to build content to help the +community get started. + +I used to be a developer, but I'm a bad developer for sure. So that's why I'm +trying to help the project in other ways, in all the directions. And yeah, my +goal is increase the adoption of the open standards, making sure that it's been +adopted everywhere, so then we can move forward by implementing even more +exciting implementations. + +**VIJAY SAMUEL:** I started a few years ago for two reasons. One, we were +looking to introduce tracing inside the company, and at that time, OpenTracing +and OpenCensus was converging into OpenTelemetry. We started evaluating +OpenTelemetry for that. And given that we were moving into OpenTelemetry for +tracing, I also went through the journey of migrating our metrics collection +into OpenTelemetry. That's basically how I got involved. + +**DANIEL GOMEZ BLANCO:** How did I get involved in OpenTelemetry? I got involved +through my work at Skyscanner, as an end user. I was driving adoption and open +standards for telemetry. During COVID there was a need for simplification and +how we approach infrastructure, how we approach, how we collect, how we process, +and how we export telemetry data, and also basically... to basically lead the +adoption of open standards and their simplification effort. So as an +observability lead, I got more involved in the community aspect of +OpenTelemetry, decided to interact with all their end users and meeting people +that want to solve the same problems and want to find a solution that works for +everyone. + +**DOUG ODEGAARD:** So, OpenTelemetry, I actually, for several years, in my +previous position, I was hired to actually develop observability software. I was +writing my own thing, we were doing a lot of alert management and various +things. It was so much work and I thought, this has got to be easier. Plus I +wanted to make sure that it could be future, future proof, dare I use that term? +But also extensible. + +And when I discovered OpenTelemetry, I was just like, oh, thank you. Because +it's something that the company could carry forward. And also we didn't have to +worry about storing the data as much. And so it's really provided a really +excellent platform so that we can focus on the task at hand versus how to do the +job. So how I got involved in the project was actually first as a customer. It +was about three, close to four years ago, kind of the infancy of OpenTelemetry. +And I would go online, I would look at the documentation, or I would be in the +code a lot, but I wanted to learn more. So I would go to a SIG call and there +would be someone from Google and Microsoft and other companies, and then there +was this guy from this small fintech in the US. And at first it was a little +awkward, but they were so excited to have me in the call because I was an end +user. And so it really was, it was a wonderful experience to begin that way, to +realize that I could contribute to this rather than simply be a consumer of it. +So it was great. And then I transitioned my career into working for a vendor, +and we implement these systems now for customers like myself that I was years +ago. So it's kind of a pay it forward, give back type of thing. + +**ADNAN RAHIĆ:** How did we get involved into the OpenTelemetry project? We +started contributing more to the blog with you guys started contributing a bit +to the docs as well. And yeah, it's just been a whole-hearted effort in the team +to always kind of dedicate a few, a few minutes of each day to check out the +OpenTelemetry project, find a way to contribute. + +**RYNN MANCUSO:** I got involved in the OpenTelemetry project...honestly, I was +working at one observability company in marketing, and they didn't see the +point. They didn't want me to get involved. And I really believed in open +source. I'd worked in Mozilla and Wikimedia and really believed that, like, this +was the way forward from a strategic perspective. So the second I could switch +to a company that did let me get involved, that's what I did. And now I'm at +Honeycomb. And I'm glad to say within the first three months, I made project +member and started working with the End User Working Group and worked to grow it +into a SIG, into all the programs that it has today, together with others. + +### 5- What's your favorite telemetry signal? + +**IRIS DYRMISHI:** Tracing is my favorite signal. + +**SEVERIN NEUMANN:** My favorite signal now is profiling, because I think this +is really closing a big gap that was missing in observability, right? So I +mentioned before, right, I come from the APM space, and now for me, APM, +observability, it's very hard to make, like, a difference here. But one thing +that when I talk with people using APM products right now is they're like, hey, +where's code level visibility with OpenTelemetry, right? My commercial agent is +giving me that line of code that is breaking something. And this is what we get +with profiling. And that's why I'm really, really excited about it. + +**KAYLA REOPELLE:** To decide a favorite signal is kind of difficult for me. I +really love the power of traces. I think that traces can tell stories in ways +that are very meaningful. But on the same, like, on the other hand, I've been so +immersed in logs and trying to allow logs to have more connections to spans and +traces, I definitely have a soft spot for logs as well. + +**MORGAN MCLEAN:** I mean, I'm partial to distributed traces because that's +where this project got its start. And I think early on, that's where a lot of +the value was. No one else was really doing standardized distributed trace +collection right? There were some open source examples of it attached to, like, +Zipkin and Jaeger. But I think the reason OpenTelemetry got so much traction so +quickly is that it was providing that. + +I'm also partial to logs, which we launched last year, just because that's one +where, like, I've been involved in a lot of parts of OTel... But that's one +where like, I was involved in a lot of the core specification early on in +driving that. And so it was really exciting to see that ship. Also, logs are +just a thing that throughout my career before working on any of this, I just get +frustrated with, because they're never standardized, slow to process, they're +expensive. OTel going to bring a lot of changes there for the better for +everyone who uses logs. + +And finally, I guess profiles, because I work on that now. When I was at Google +many years ago, I launched what I think was the world's first distributed +continuous profiling product, at least publicly available one, which was Google +cloud profiling, Stackdriver profiling, they still support it, I still think +it's free, it's very powerful. But profiling has always been a bit of a niche +thing. Like, I know, like at Splunk and other companies, we support it, but it's +not as well known as metrics, and traces, and logs. I think with OTel, starting +later this year, we're gonna launch like full support for profiles. That's +really gonna change. Like, we had customers at Google who would spend an hour of +our profiler and save like 20, 30% of their aggregate compute because they found +some really poorly optimized code really quickly. For more people to have that +ability and speed things up and for developers actually to get insight into how +things work, that's super exciting. Like, the tech has been there a long time +and OTel bringing this mainstream is huge. + +**HENRIK REXED:** When people ask me, who is your favorite kid? Usually I say, I +don't have a favorite kid, you know. All my kids are wonderful. They all have, I +don't know, a great thing, you know, out of it. So I think I love traces because +sometimes it helps you to understand where it slowed down. I love metrics +because as a performance engineer, I used to use metrics a lot. And I love logs +because logs at the end, there's no sampling. So if you just do analytics on +logs, wow, you are so much precise. + +So I don't think I have a favorite signal. I'll just say that depending on what +I need and pick and choose, there's clearly one signal that will help me more. +There's one thing that I'm very eager and waiting since Valencia is continuous +profiling, because I love profiling and I think traces is great, but if there is +a problem somewhere, profiling would be so much helpful. So I think, yeah, I +don't answer your questions, but I say, yeah, I love all the signals provided by +OpenTelemetry. + +**VIJAY SAMUEL:** I am thoroughly biased towards metrics. I feel metrics are the +most powerful signal. As long as you are thinking through your instrumentation +and making sure that you have the right granularity cardinality being sent in, +to the platform, you can do powerful, powerful things with regards to anomaly +detection, machine learning and many other things. So I love metrics. + +**DANIEL GOMEZ BLANCO:** I mean, I have to say traces, because they give you the +context. Traces give you the backbone correlation for all the other signals, +right? But I do think that the current design of the API design of metrics is so +powerful that I'm like falling in love again with metrics because of that way +that we decouple instrumentation and measurement from aggregation of metrics is +so powerful and so much richness to basically give us a way to describe our +systems, that I'm falling back again in love with metrics. + +**DOUG ODEGAARD:** My favorite signal, I have to say, I'm partial to traces +because I've been doing software development for so long that that was the first +thing that really turned me on to it was the ability to see that, especially +because I know what it's like, like to debug. But it's also, I also know what +it's like in an incident to have to focus in very quickly. So yes, traces are my +favorite, but I do also like to send that trace ID and span ID into the logs +now. It's kind of becoming my next favorite. + +**ADNAN RAHIĆ:** My favorite signal is traces. I'm going to say traces, +definitely. My favorite singer is Ed Sheeran. + +**RYNN MANCUSO:** What is my favorite signal? I mean, I work for Honeycomb, so I +am constitutionally obliged to say traces are my favorite signal. + +## Join us! + +If you have a story to share about how you use OpenTelemetry at your +organization, we’d love to hear from you! Ways to share: + +- Join the + [#otel-sig-end-user channel](https://cloud-native.slack.com/archives/C01RT3MSWGZ) + on the + [CNCF Community Slack](https://communityinviter.com/apps/cloud-native/cncf) +- Join our [OTel in Practice](/community/end-user/otel-in-practice/) sessions +- Share your stories on the [OpenTelemetry blog](/docs/contributing/blog/) +- Contact us on the + [CNCF Community Slack](https://communityinviter.com/apps/cloud-native/cncf) + for any other types of sessions you'd like to see! + +Be sure to follow OpenTelemetry on +[Mastodon](https://fosstodon.org/@opentelemetry) and +[LinkedIn](https://www.linkedin.com/company/opentelemetry/), and share your +stories using the **#OpenTelemetry** hashtag! + +And don't forget to subscribe to our +[YouTube channel](https://youtube.com/@otel-official) for more great +OpenTelemetry content! diff --git a/content/en/blog/2024/new-otel-features-envoy-istio/index.md b/content/en/blog/2024/new-otel-features-envoy-istio/index.md index bc94ca7c3c3e..7c030b4140e9 100644 --- a/content/en/blog/2024/new-otel-features-envoy-istio/index.md +++ b/content/en/blog/2024/new-otel-features-envoy-istio/index.md @@ -182,7 +182,7 @@ And finally, we configure the `OTEL_RESOURCE_ATTRIBUTES` environment variable for the Envoy proxies: ```shell -cat <
and build site with Hugo] - C --- D[Push source to the fork] - D --- E[Open a pull request] - E --- F[Sign the CNCF CLA] - end - -classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; -classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold -classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 -class A,B,C,D,E,F,G,H grey -class S,T spacewhite -class first,second white -``` - -_Figure 1. Contributing new content._ - -The previous figure illustrates how to contribute new documentation. - -To contribute new content pages or improve existing content pages, open a pull -request (PR): - -- If your change is small, or you're unfamiliar with Git, read - [Changes using GitHub](#changes-using-github) to learn how to edit a page. -- If your changes are large, read [Work from a local fork](#fork-the-repo) to - learn how to make changes locally on your computer. - -{{% alert title="Tip" %}} - -Turn your pull request into a draft to signal that the content still isn't ready -for review. Maintainers may still comment or do high-level reviews, though they -won't review the content in full until you remove the draft status. - -{{% /alert %}} - -### Changes using GitHub {#changes-using-github} - -If you're less experienced with Git workflows, here's an easier method of -opening a pull request. Figure 2 outlines the steps and the details follow. - -```mermaid -flowchart LR -A([fa:fa-user New
Contributor]) --- id1[(open-telemetry/opentelemetry.io
GitHub)] -subgraph tasks[Changes using GitHub] -direction TB - 0[ ] -.- - 1[1. Edit this page] --> 2[2. Use GitHub markdown
editor to make changes] - 2 --> 3[3. fill in Propose file change] - -end -subgraph tasks2[ ] -direction TB -4[4. select Propose file change] --> 5[5. select Create pull request] --> 6[6. fill in Open a pull request] -6 --> 7[7. select Create pull request] -end - -id1 --> tasks --> tasks2 - -classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; -classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold -classDef k8s fill:#326ce5,stroke:#fff,stroke-width:1px,color:#fff; -classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 -class A,1,2,3,4,5,6,7 grey -class 0 spacewhite -class tasks,tasks2 white -class id1 k8s -``` - -_Figure 2. Steps for opening a PR using GitHub._ - -1. On the page where you see the issue, select the **Edit this page** option in - the right-hand side navigation panel. - -1. If you're not a member of the project, GitHub offers to create a fork of the - repository. Select **Fork this repository**. - -1. Make your changes in the GitHub editor. - -1. Fill in the **Propose file change** form. - -1. Select **Propose file change**. - -1. Select **Create pull request**. - -1. The **Open a pull request** screen appears. Your description helps reviewers - understand your change. - -1. Select **Create pull request**. - -Before merging a pull request, OpenTelemetry community members review and -approve it. - -If a reviewer asks you to make changes: - -1. Go to the **Files changed** tab. -1. Select the pencil (edit) icon on any files changed by the pull request. -1. Make the changes requested. If there's a code suggestion, apply it. -1. Commit the changes. - -When your review is complete, a reviewer merges your PR and your changes goes -live a few minutes later. - -{{% alert title="Tip" %}} - -Comment `/fix:format` on your pull request to trigger an automated check for -formatting issues. - -{{% /alert %}} - -### Work from a local fork {#fork-the-repo} - -If you're more experienced with Git, or if your changes are larger than a few -lines, work from a local fork. - -Make sure you have -[git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed -on your computer. You can also use a user interface for Git. - -Figure 3 shows the steps to follow when you work from a local fork. The details -for each step follow. - -```mermaid -flowchart LR -1[Fork the open-telemetry/opentelemetry
repository] --> 2[Create local clone
and set upstream] -subgraph changes[Your changes] -direction TB -S[ ] -.- -3[Create a branch
example: my_new_branch] --> 3a[Make changes using
a text editor] --> 4["Preview your changes
locally using Hugo
(localhost:1313)"] -end -subgraph changes2[Commit / Push] -direction TB -T[ ] -.- -5[Commit your changes] --> 6[Push commit to
origin/my_new_branch] -end - -2 --> changes --> changes2 - -classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; -classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold -classDef k8s fill:#326ce5,stroke:#fff,stroke-width:1px,color:#fff; -classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 -class 1,2,3,3a,4,5,6 grey -class S,T spacewhite -class changes,changes2 white -``` - -_Figure 3. Working from a local fork to make your changes._ - -#### Fork the opentelemetry.io repository - -1. Navigate to the - [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io/) - repository. -1. Select **Fork**. - -#### Create a local clone and set the upstream - -1. In a terminal window, clone your fork and install the requirements: - - ```shell - git clone git@github.com:
head repository drop-down menu] -end -subgraph second [ ] -direction TB -5[5. Select your branch from
the compare drop-down menu] --> 6[6. Select Create Pull Request] -6 --> 7[7. Add a description
to your PR] -7 --> 8[8. Select Create pull request] -end - -first --> second - -classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; -classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold -class 1,2,3,4,5,6,7,8 grey -class first,second white -``` - -_Figure 4. Steps to open a PR from your fork to_ -[opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io). - -1. In a web browser, go to the - [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io) - repository. -1. Select **New Pull Request**. -1. Select **compare across forks**. -1. From the **head repository** drop-down menu, select your fork. -1. From the **compare** drop-down menu, select your branch. -1. Select **Create Pull Request**. -1. Add a description for your pull request: - - - **Title** (50 characters or less): Summarize the intent of the change. - - **Description**: Describe the change in more detail. - - - If there is a related GitHub issue, include `Fixes #12345` or - `Closes #12345` in the description so that GitHub's automation closes the - mentioned issue after merging the PR. If there are other related PRs, - link those as well. - - If you want advice on something specific, include any questions you'd - like reviewers to think about in your description. +The following guides describe how to contribute to OpenTelemetry documentation. -1. Select the **Create pull request** button. - -Your pull request is available in -[Pull requests](https://github.com/open-telemetry/opentelemetry.io/pulls). - -After opening a PR, GitHub runs automated tests and tries to deploy a preview -using [Netlify](https://www.netlify.com/). - -- If the Netlify build fails, select **Details** for more information. -- If the Netlify build succeeds, select **Details** to open a staged version of - the OpenTelemetry website with your changes applied. This is how reviewers - check your changes. - -Other checks might also fail. See the -[list of all PR checks](/docs/contributing/pr-checks). - -#### Fix content issues automatically - -Before submitting a change to the repository, run the following command and (i) -address any reported issues, (ii) commit any files changed by the script: - -```sh -npm run test-and-fix -``` - -To separately test and fix all issues with your files, run: - -```sh -npm run test # Checks but does not update any files -npm run fix:all # May update files -``` - -To list available NPM scripts, run `npm run`. - -#### Preview your changes locally {#preview-locally} - -Preview your changes locally before pushing them or opening a pull request. A -preview lets you catch build errors or markdown formatting problems. - -To build and serve the site locally with Hugo, run the following command: - -```shell -npm run serve -``` - -Navigate to `http://localhost:1313` in your web browser to see the local -preview. Hugo watches for changes and rebuilds the site as needed. - -To stop the local Hugo instance, go back to the terminal and type `Ctrl+C`, or -close the terminal window. - -#### Site deploys and PR previews - -If you submit a PR, Netlify creates a [deploy preview][] so that you can review your -changes. Once your PR is merged, Netlify deploys the updated site to the production -server. - -> **Note**: PR previews include _draft pages_, but production builds do not. - -To see deploy logs and more, visit the project's [dashboard][] -- Netlify login -required. - -#### PR guidelines - -Before a PR gets merged, it sometimes requires a few iterations of -review-and-edit. To help us and yourself make this process as easy as possible, -we ask that you adhere to the following: - -- If your PR isn't a quick fix, then **work from a fork**: Click the - [Fork](https://github.com/open-telemetry/opentelemetry.io/fork) button at the - top of the repository and clone the fork locally. When you are ready, raise a - PR with the upstream repository. -- **Do not work from the `main`** branch of your fork, but create a PR-specific - branch. -- Ensure that maintainers are - [allowed to apply changes to your pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). - -#### Changes from reviewers - -Sometimes reviewers commit to your pull request. Before making any other -changes, fetch those commits. - -1. Fetch commits from your remote fork and rebase your working branch: - - ```shell - git fetch origin - git rebase origin/
and build site with Hugo] + C --- D[Push source to the fork] + D --- E[Open a pull request] + E --- F[Sign the CNCF CLA] + end + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class A,B,C,D,E,F,G,H grey +class S,T spacewhite +class first,second white +``` + +_Figure 1. Contributing new content._ + +## Changes using GitHub {#changes-using-github} + +If you're less experienced with Git workflows, here's an easier method of +opening a pull request. Figure 2 outlines the steps and the details follow. + +```mermaid +flowchart LR +A([fa:fa-user New
Contributor]) --- id1[(open-telemetry/opentelemetry.io
GitHub)] +subgraph tasks[Changes using GitHub] +direction TB + 0[ ] -.- + 1[1. Edit this page] --> 2[2. Use GitHub markdown
editor to make changes] + 2 --> 3[3. fill in Propose file change] + +end +subgraph tasks2[ ] +direction TB +4[4. select Propose file change] --> 5[5. select Create pull request] --> 6[6. fill in Open a pull request] +6 --> 7[7. select Create pull request] +end + +id1 --> tasks --> tasks2 + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef k8s fill:#326ce5,stroke:#fff,stroke-width:1px,color:#fff; +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class A,1,2,3,4,5,6,7 grey +class 0 spacewhite +class tasks,tasks2 white +class id1 k8s +``` + +_Figure 2. Steps for opening a PR using GitHub._ + +1. On the page where you see the issue, select the **Edit this page** option in + the right-hand side navigation panel. + +1. If you're not a member of the project, GitHub offers to create a fork of the + repository. Select **Fork this repository**. + +1. Make your changes in the GitHub editor. + +1. Fill in the **Propose file change** form. + +1. Select **Propose file change**. + +1. Select **Create pull request**. + +1. The **Open a pull request** screen appears. Your description helps reviewers + understand your change. + +1. Select **Create pull request**. + +Before merging a pull request, OpenTelemetry community members review and +approve it. + +If a reviewer asks you to make changes: + +1. Go to the **Files changed** tab. +1. Select the pencil (edit) icon on any files changed by the pull request. +1. Make the changes requested. If there's a code suggestion, apply it. +1. Commit the changes. + +When your review is complete, a reviewer merges your PR and your changes goes +live a few minutes later. + +{{% alert title="Tip" %}} + +Comment `/fix:format` on your pull request to trigger an automated check for +formatting issues. + +{{% /alert %}} + +## Work from a local fork {#fork-the-repo} + +If you're more experienced with Git, or if your changes are larger than a few +lines, work from a local fork. + +Make sure you have +[git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed +on your computer. You can also use a user interface for Git. + +Figure 3 shows the steps to follow when you work from a local fork. The details +for each step follow. + +```mermaid +flowchart LR +1[Fork the open-telemetry/opentelemetry
repository] --> 2[Create local clone
and set upstream] +subgraph changes[Your changes] +direction TB +S[ ] -.- +3[Create a branch
example: my_new_branch] --> 3a[Make changes using
a text editor] --> 4["Preview your changes
locally using Hugo
(localhost:1313)"] +end +subgraph changes2[Commit / Push] +direction TB +T[ ] -.- +5[Commit your changes] --> 6[Push commit to
origin/my_new_branch] +end + +2 --> changes --> changes2 + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef k8s fill:#326ce5,stroke:#fff,stroke-width:1px,color:#fff; +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class 1,2,3,3a,4,5,6 grey +class S,T spacewhite +class changes,changes2 white +``` + +_Figure 3. Working from a local fork to make your changes._ + +### Fork the opentelemetry.io repository + +1. Navigate to the + [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io/) + repository. +1. Select **Fork**. + +### Create a local clone and set the upstream + +1. In a terminal window, clone your fork and install the requirements: + + ```shell + git clone git@github.com:
head repository drop-down menu] +end +subgraph second [ ] +direction TB +5[5. Select your branch from
the compare drop-down menu] --> 6[6. Select Create Pull Request] +6 --> 7[7. Add a description
to your PR] +7 --> 8[8. Select Create pull request] +end + +first --> second + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +class 1,2,3,4,5,6,7,8 grey +class first,second white +``` + +_Figure 4. Steps to open a PR from your fork to_ +[opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io). + +1. In a web browser, go to the + [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io) + repository. +1. Select **New Pull Request**. +1. Select **compare across forks**. +1. From the **head repository** drop-down menu, select your fork. +1. From the **compare** drop-down menu, select your branch. +1. Select **Create Pull Request**. +1. Add a description for your pull request: + + - **Title** (50 characters or less): Summarize the intent of the change. + - **Description**: Describe the change in more detail. + + - If there is a related GitHub issue, include `Fixes #12345` or + `Closes #12345` in the description so that GitHub's automation closes the + mentioned issue after merging the PR. If there are other related PRs, + link those as well. + - If you want advice on something specific, include any questions you'd + like reviewers to think about in your description. + +1. Select the **Create pull request** button. + +Your pull request is available in +[Pull requests](https://github.com/open-telemetry/opentelemetry.io/pulls). + +After opening a PR, GitHub runs automated tests and tries to deploy a preview +using [Netlify](https://www.netlify.com/). + +- If the Netlify build fails, select **Details** for more information. +- If the Netlify build succeeds, select **Details** to open a staged version of + the OpenTelemetry website with your changes applied. This is how reviewers + check your changes. + +Other checks might also fail. See the +[list of all PR checks](/docs/contributing/pr-checks). + +### Fix content issues automatically + +Before submitting a change to the repository, run the following command and (i) +address any reported issues, (ii) commit any files changed by the script: + +```sh +npm run test-and-fix +``` + +To separately test and fix all issues with your files, run: + +```sh +npm run test # Checks but does not update any files +npm run fix:all # May update files +``` + +To list available NPM scripts, run `npm run`. See +[PR checks](/docs/contributing/pr-checks) for more information on pull request +checks and how to fix errors automatically. + +### Preview your changes locally {#preview-locally} + +Preview your changes locally before pushing them or opening a pull request. A +preview lets you catch build errors or markdown formatting problems. + +To build and serve the site locally with Hugo, run the following command: + +```shell +npm run serve +``` + +Navigate to `http://localhost:1313` in your web browser to see the local +preview. Hugo watches for changes and rebuilds the site as needed. + +To stop the local Hugo instance, go back to the terminal and type `Ctrl+C`, or +close the terminal window. + +### Site deploys and PR previews + +If you submit a PR, Netlify creates a [deploy preview][] so that you can review your +changes. Once your PR is merged, Netlify deploys the updated site to the production +server. + +> **Note**: PR previews include _draft pages_, but production builds do not. + +To see deploy logs and more, visit the project's [dashboard][] -- Netlify login +required. + +### PR guidelines + +Before a PR gets merged, it sometimes requires a few iterations of +review-and-edit. To help us and yourself make this process as easy as possible, +we ask that you adhere to the following: + +- If your PR isn't a quick fix, then **work from a fork**: Click the + [Fork](https://github.com/open-telemetry/opentelemetry.io/fork) button at the + top of the repository and clone the fork locally. When you are ready, raise a + PR with the upstream repository. +- **Do not work from the `main`** branch of your fork, but create a PR-specific + branch. +- Ensure that maintainers are + [allowed to apply changes to your pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork). + +### Changes from reviewers + +Sometimes reviewers commit to your pull request. Before making any other +changes, fetch those commits. + +1. Fetch commits from your remote fork and rebase your working branch: + + ```shell + git fetch origin + git rebase origin/
(redis))] cartservice(Cart Service):::dotnet diff --git a/content/en/docs/demo/feature-flags.md b/content/en/docs/demo/feature-flags.md index f7a798f4b625..4b9fd1c72999 100644 --- a/content/en/docs/demo/feature-flags.md +++ b/content/en/docs/demo/feature-flags.md @@ -19,7 +19,7 @@ change the `defaultVariant` value in the config file for a given flag to "on". | `adServiceManualGc` | Ad Service | Trigger full manual garbage collections in the ad service | | `adServiceHighCpu` | Ad Service | Trigger high cpu load in the ad service. If you want to demo cpu throttling, set cpu resource limits | | `cartServiceFailure` | Cart Service | Generate an error for `EmptyCart` 1/10th of the time | -| `productCatalogFailure` | Product Catalog | Generate an error for `GetProduct` requests with product id: `OLJCESPC7Z` | +| `productCatalogFailure` | Product Catalog | Generate an error for `GetProduct` requests with product ID: `OLJCESPC7Z` | | `recommendationServiceCacheFailure` | Recommendation | Create a memory leak due to an exponentially growing cache. 1.4x growth, 50% of requests trigger growth. | | `paymentServiceFailure` | Payment Service | Generate an error when calling the `charge` method. | | `paymentServiceUnreachable` | Checkout Service | Use a bad address when calling the PaymentService to make it seem like the PaymentService is unavailable. | diff --git a/content/en/docs/demo/services/_index.md b/content/en/docs/demo/services/_index.md index ce9f0392d942..b09a35f1c016 100644 --- a/content/en/docs/demo/services/_index.md +++ b/content/en/docs/demo/services/_index.md @@ -8,7 +8,7 @@ To visualize request flows, see the [Service Diagram](../architecture/). | Service | Language | Description | | ----------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| [accountingservice](accounting/) | Go | Processes incoming orders and count the sum of all orders (mock/). | +| [accountingservice](accounting/) | .NET | Processes incoming orders and count the sum of all orders (mock/). | | [adservice](ad/) | Java | Provides text ads based on given context words. | | [cartservice](cart/) | .NET | Stores the items in the user's shopping cart in Redis and retrieves it. | | [checkoutservice](checkout/) | Go | Retrieves user cart, prepares order and orchestrates the payment, shipping and the email notification. | diff --git a/content/en/docs/demo/services/accounting.md b/content/en/docs/demo/services/accounting.md index 3523356c026f..f7e0fb200b0f 100644 --- a/content/en/docs/demo/services/accounting.md +++ b/content/en/docs/demo/services/accounting.md @@ -2,7 +2,6 @@ title: Accounting Service linkTitle: Accounting aliases: [accountingservice] -cSpell:ignore: otelsarama otlptracegrpc sarama sdktrace --- This service calculates the total amount of sold products. This is only mocked @@ -10,54 +9,21 @@ and received orders are printed out. [Accounting Service](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/accountingservice/) -## Traces +## Auto-instrumentation -### Initializing Tracing +This service relies on the OpenTelemetry .NET Automatic Instrumentation to +automatically instrument libraries such as Kafka, and to configure the +OpenTelemetry SDK. The instrumentation is added via Nuget package +[OpenTelemetry.AutoInstrumentation](https://www.nuget.org/packages/OpenTelemetry.AutoInstrumentation) +and activated using environment variables that are sourced from `instrument.sh`. +Using this installation approach also guarantees that all instrumentation +dependencies are properly aligned with the application. -The OpenTelemetry SDK is initialized from `main` using the `initTracerProvider` -function. +## Publishing -```go -func initTracerProvider() (*sdktrace.TracerProvider, error) { - ctx := context.Background() +Add `--use-current-runtime` to the `dotnet publish` command to distribute +appropriate native runtime components. - exporter, err := otlptracegrpc.New(ctx) - if err != nil { - return nil, err - } - tp := sdktrace.NewTracerProvider( - sdktrace.WithBatcher(exporter), - sdktrace.WithResource(initResource()), - ) - otel.SetTracerProvider(tp) - otel.SetTextMapPropagator(propagation.NewCompositeTextMapPropagator(propagation.TraceContext{}, propagation.Baggage{})) - return tp, nil -} -``` - -You should call `TracerProvider.Shutdown()` when your service is shutdown to -ensure all spans are exported. This service makes that call as part of a -deferred function in main - -```go -tp, err := initTracerProvider() -if err != nil { - log.Fatal(err) -} -defer func() { - if err := tp.Shutdown(context.Background()); err != nil { - log.Printf("Error shutting down tracer provider: %v", err) - } -}() -``` - -### Adding Kafka ( Sarama ) auto-instrumentation - -This service will receive the processed results of the Checkout Service via a -Kafka topic. To instrument the Kafka client the ConsumerHandler implemented by -the developer has to be wrapped. - -```go -handler := groupHandler{} // implements sarama.ConsumerGroupHandler -wrappedHandler := otelsarama.WrapConsumerGroupHandler(&handler) +```sh +dotnet publish "./AccountingService.csproj" --use-current-runtime -c $BUILD_CONFIGURATION -o /app/publish /p:UseAppHost=false ``` diff --git a/content/en/docs/demo/services/cart.md b/content/en/docs/demo/services/cart.md index d325d9d6f74e..075f250e838c 100644 --- a/content/en/docs/demo/services/cart.md +++ b/content/en/docs/demo/services/cart.md @@ -25,8 +25,8 @@ and resource attributes is performed through environment variables. ```cs Action
并用 Hugo 构建网站] + C --- D[提交源文件到克隆的仓库] + D --- E[发起拉取请求（PR）] + E --- F[签署 CNCF CLA] + end + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class A,B,C,D,E,F,G,H grey +class S,T spacewhite +class first,second white +``` + +_图 1. 贡献新的内容。_ + +上图描述了如何贡献新的文档。 + +要贡献新的内容页面或改进现有的内容页面，请发起拉取请求 (PR)： + +- 如果你的更改很小，或者你不太熟悉Git的使用，请阅读[使用 GitHub 进行更改](#changes-using-github) 来学习如何编辑一个页面。 +- 如果你的更改较大，请阅读[在本地分支进行更改](#fork-the-repo) 来学习如何在你电脑本地进行更改。 + +{{% alert title="提醒" %}} + +可以将你的拉取请求变成草稿状态以表明内容未准备好接受评审。此时维护者仍可以发表评论或进行高级别的评审，但他们不会全面评审内容直到你删除草稿状态。 + +{{% /alert %}} + +### 使用 GitHub 进行更改 {#changes-using-github} + +如果你对 Git 工作流程不太熟悉，这里有一种更简单的方法来发起拉取请求。图 2 概述了步骤，详细信息如下。 + +```mermaid +flowchart LR +A([fa:fa-user 新贡献者]) --- id1[(open-telemetry/opentelemetry.io
GitHub仓库)] +subgraph tasks[使用 GitHub 进行更改] +direction TB + 0[ ] -.- + 1[1. 选择 Edit this page] --> 2[2. 使用 GitHub markdown
编辑器进行编辑] + 2 --> 3[3. 填写 Propose file change] + +end +subgraph tasks2[ ] +direction TB +4[4. 选择 Propose file change] --> 5[5. 选择 Create pull request] --> 6[6. 填写 Open a pull request] +6 --> 7[7. 选择 Create pull request] +end + +id1 --> tasks --> tasks2 + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef k8s fill:#326ce5,stroke:#fff,stroke-width:1px,color:#fff; +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class A,1,2,3,4,5,6,7 grey +class 0 spacewhite +class tasks,tasks2 white +class id1 k8s +``` + +_图 2. 使用 GitHub 发起拉取请求的流程。_ + +1. 在发现问题的页面上，选择右侧导航面板中的 **Edit this page** 选项。 +2. 如果你不是该项目的成员，GitHub 会建议你创建仓库的分支。选择 **Fork this repository**。 +3. 在 GitHub 编辑器中进行更改。 +4. 填写 **Propose file change** 表格。 +5. 选择 **Propose changes**。 +6. 选择 **Create pull request**。 +7. 进入 **Open a pull request** 页面，填写描述可以帮助评审人理解你的更改内容。 +8. 选择 **Create pull request**。 + +合并拉取请求需要OpenTelemetry 社区成员评审和批准。 + +如果评审人要求你进行修改： + +1. 前往 **Files changed** 选项卡。 +2. 选择拉取请求所更改的任何文件上的 **edit** 图标。 +3. 进行所要求的更改。如果有代码建议，请应用它。 +4. 提交更改。 + +审核完成后，审核者会合并你的 PR，并且你的更改将在几分钟后生效。 + +{{% alert title="提醒" %}} + +在你的拉取请求上评论 `/fix:format` 可以触发格式问题的自动检查。 + +{{% /alert %}} + +### 在本地分支进行更改 {#fork-the-repo} + +如果你有使用 Git 的经验，或者你的更改较多，请在本地分支进行更改。 + +请确保你的计算机上已安装 [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) 。你也可以使用 Git 的图形用户界面。 + +图 3 显示了在本地分支进行更改时要遵循的步骤。每个步骤的详细信息如下。 + +```mermaid +flowchart LR +1[克隆 open-telemetry/opentelemetry 仓库] --> 2[创建本地克隆仓库
并设置上游仓库] +subgraph changes[你的更改] +direction TB +S[ ] -.- +3[创建一个分支
例如: my_new_branch] --> 3a[使用文本编辑器进行更改] --> 4["在本地使用 Hugo
预览你的变更
(localhost:1313)"] +end +subgraph changes2[提交/推送代码] +direction TB +T[ ] -.- +5[提交你的更改] --> 6[推送更改到
origin/my_new_branch] +end + +2 --> changes --> changes2 + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +classDef k8s fill:#326ce5,stroke:#fff,stroke-width:1px,color:#fff; +classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 +class 1,2,3,3a,4,5,6 grey +class S,T spacewhite +class changes,changes2 white +``` + +_图 3. 在本地分支进行更改_。 + +#### 克隆 opentelemetry.io 仓库 + +1. 导航到 [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io/) 仓库。 +2. 点击 **Fork** 按钮。 + +#### 创建本地克隆仓库并设置上游仓库 + +1. 在一个终端窗口中，下载你克隆的仓库代码，并安装所需的依赖项： + + ```shell + git clone git@github.com:
选择你的fork] +end +subgraph second [ ] +direction TB +5[5. 从 compare 下拉菜单
选择你的分支] --> 6[6. 选择 Create Pull Request] +6 --> 7[7. 给你的拉取请求
添加描述] +7 --> 8[8. 选择 Create pull request] +end + +first --> second + +classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; +classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold +class 1,2,3,4,5,6,7,8 grey +class first,second white +``` + +_图 4. 从你的 fork 向 [opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io) 提交 PR 的步骤。_ + +1. 在 Web 浏览器中，转到 [`opentelemetry.io`](https://github.com/open-telemetry/opentelemetry.io) 仓库。 +2. 选择 **New Pull Request**。 +3. 选择 **compare across fork**。 +4. 从 **head repository** 下拉菜单中选择你的 fork。 +5. 从 **compare** 下拉菜单中选择你的分支。 +6. 选择 **Create Pull Request**。 +7. 为你的拉取请求添加描述： + - **Title** （不多于50 个字符）：总结更改的目的。 + - **Description** ：更详细地描述更改。 + - 如果有相关的 GitHub 问题（issue），请在描述中包含 `Fixes #12345` 或 `Closes #12345`，以便 GitHub 的自动化功能在合并 PR 后关闭提到的问题。如果还有其他相关 PR，也请链接它们。 + - 如果你需要有关特定内容的建议，请在描述中包含你希望评审人考虑的任何问题。 +8. 选择 **Create pull request** 按钮。 + +你的拉取请求可以在 [Pull requests](https://github.com/open-telemetry/opentelemetry.io/pulls) 中找到。 + +发起 PR 后，GitHub 会运行自动测试并尝试使用 [Netlify](https://www.netlify.com/) 部署预览。 + +- 如果 Netlify 构建失败，选择 **详细信息** 可以获取更多信息。 +- 如果 Netlify 构建成功，选择 **详细信息** 可以打开 OpenTelemetry 网站的暂存版本，其中应用了你的更改。评审人通过这种方式检查你的更改。 + +其他检查也可能失败。请参阅[所有 PR 检查列表](/docs/contributing/pr-checks)。 + +#### 自动修复内容问题 + +在向仓库提交更改之前，请运行以下命令并 (i)解决任何报告的问题，(ii) 提交脚本更改的任何文件： + +```sh +npm run test-and-fix +``` + +要单独测试和修复文件的所有问题，请运行： + +```sh +npm run test # 检查但不更新任何文件 +npm run fix:all # 可能更新文件 +``` + +要列出可用的 NPM 脚本，请运行 `npm run`。 + +#### 在本地预览你的更改 {#preview-locally} + +在推送更改内容或发起拉取请求之前，请在本地预览你的更改。预览可以让你捕获构建错误或 markdown 格式问题。 + +要使用 Hugo 在本地构建和运行站点，请使用以下命令： + +```shell +npm run serve +``` + +在你的 Web 浏览器中导航到 `http://localhost:1313` 可以查看本地预览。Hugo 会监视更改并根据需要重建站点。 + +要停止本地 Hugo 实例，请返回终端并键入 `Ctrl+C`，或关闭终端窗口。 + +#### 站点部署和 PR 预览 + +如果你提交了 PR，Netlify 会创建一个 [部署预览][]，以便你可以查看你的更改。一旦你的 PR 合并，Netlify 就会将更新后的站点部署到生产服务器。 + +> **注意**：PR 预览包括*草稿页面*，但生产版本不包括。 + +要查看部署日志等，请访问项目的 [仪表板][]——需要 Netlify 登录。 + +#### PR 指南 + +在 PR 合并之前，有时需要进行几次评审和编辑。为了帮助我们和你自己尽可能简化此过程，我们要求你遵守以下规定： + +- 如果你的 PR 不是一个快速的问题修复，则从 **在本地分支进行更改**开始：单击仓库顶部的 [Fork](https://github.com/open-telemetry/opentelemetry.io/fork) 按钮并创建一个你自己本地的克隆仓库。当你准备好更改内容时，向上游仓库发起PR请求。 +- **不要在你克隆仓库的`main`**分支上直接进行更改，而应该创建一个特定于 PR 的分支。 +- 确保维护人员[可以对你的拉取请求应用更改](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)。 + +#### 评审人的更改 + +有时审阅者会向你的拉取请求提交一些更改，请在进行任何其他更改之前获取这些提交。 + +1. 从远程分支获取提交并重定基你的工作分支： + + ```shell + git fetch origin + git rebase origin/
+
+ {{ partial "scripts.html" . }}
+
+
\ No newline at end of file
diff --git a/layouts/index.redirects b/layouts/index.redirects
index 280f6762074b..7e7f4ac8073a 100644
--- a/layouts/index.redirects
+++ b/layouts/index.redirects
@@ -72,3 +72,7 @@
{{ end }}
{{ return $result }}
{{ end }}
+
+{{/* Multilingual support */ -}}
+
+{{ partial "redirects/sites.redirects" . | partial "func/trim-lines.html" -}}
diff --git a/layouts/partials/docs/get-signal-status.html b/layouts/partials/docs/get-signal-status.html
new file mode 100644
index 000000000000..a1964fa143de
--- /dev/null
+++ b/layouts/partials/docs/get-signal-status.html
@@ -0,0 +1,31 @@
+{{/*
+
+ Returns the maturity status of the given signal for the given language.
+
+ Arguments:
+
+ .lang the instrumentation language
+ .signal the signal name; must be a legal field of the Instrumentation data file.
+
+ */ -}}
+
+{{ $status := "-" -}}
+{{ $signal := .signal -}}
+
+{{ with index site.Data.instrumentation .lang -}}
+ {{ with index .status $signal -}}
+ {{ $statusWeCanLinkTo := "stable development" -}}
+ {{ $status = cond (or (eq "experimental" .) (eq "in development" .)) "development" . -}}
+ {{ $humanizedStatus := humanize $status -}}
+ {{ $status = cond (in $statusWeCanLinkTo $status)
+ (printf "[%s](/docs/specs/otel/versioning-and-stability/#%s)" $humanizedStatus $status)
+ (cond (in "alpha beta" $status)
+ (printf "[%s](https://github.com/open-telemetry/oteps/blob/main/text/0232-maturity-of-otel.md#%s)" $humanizedStatus $status)
+ $humanizedStatus)
+ -}}
+ {{ end -}}
+{{ else -}}
+ {{ errorf "The site.Data.instrumentation map has no language key '%s'." .lang -}}
+{{ end -}}
+
+{{ return $status -}}
diff --git a/layouts/partials/ecosystem/registry/entry.html b/layouts/partials/ecosystem/registry/entry.html
index 1deb61e89ab7..488269f342f4 100644
--- a/layouts/partials/ecosystem/registry/entry.html
+++ b/layouts/partials/ecosystem/registry/entry.html
@@ -10,7 +10,7 @@
"icon" "fab fa-npm")
"packagist" (dict
"urlPattern" "https://packagist.org/packages/%s"
- "installLine" "composer install %s"
+ "installLine" "composer require %s"
"installTemplate" "ecosystem/registry/quickinstall/default.md"
"icon" "fa-solid fa-box-open")
"gems" (dict
diff --git a/layouts/partials/func/trim-lines.html b/layouts/partials/func/trim-lines.html
new file mode 100644
index 000000000000..db3b92212962
--- /dev/null
+++ b/layouts/partials/func/trim-lines.html
@@ -0,0 +1,3 @@
+{{ range split . "\n" -}}
+{{ trim . " \t" }}
+{{ end -}}
diff --git a/layouts/partials/i18n/fallback-page.html b/layouts/partials/i18n/fallback-page.html
new file mode 100644
index 000000000000..a4d7399bd2cb
--- /dev/null
+++ b/layouts/partials/i18n/fallback-page.html
@@ -0,0 +1,25 @@
+{{/*
+
+ Returns the fallback page of this page, if it has one.
+ A fallback page, is a page in the default site language
+ that has been mounted under this locale as a fallback
+ when this locale is missing a translation.
+
+*/ -}}
+
+{{ $result := false -}}
+
+{{ if and .Site.IsMultiLingual .File -}}
+ {{ $defaultLang := .Site.Sites.Default.Language.Lang -}}
+
+ {{ $resultsArray := where .Translations "Lang" $defaultLang -}}
+ {{ $defaultLangPage := index $resultsArray 0 -}}
+ {{ if and $defaultLangPage
+ $defaultLangPage.File
+ (eq .File.Filename $defaultLangPage.File.Filename)
+ -}}
+ {{ $result = $defaultLangPage -}}
+ {{ end -}}
+{{ end -}}
+
+{{ return $result -}}
diff --git a/layouts/partials/i18n/lang.html b/layouts/partials/i18n/lang.html
new file mode 100644
index 000000000000..97f8b5404c40
--- /dev/null
+++ b/layouts/partials/i18n/lang.html
@@ -0,0 +1,6 @@
+{{ $fallbackPage := partial "i18n/fallback-page.html" . -}}
+{{ $lang := .Site.Language.Lang -}}
+{{ with $fallbackPage -}}
+ {{ $lang = .Language.Lang -}}
+{{ end -}}
+{{ return $lang -}}
diff --git a/layouts/partials/redirects/sites.redirects b/layouts/partials/redirects/sites.redirects
new file mode 100644
index 000000000000..70aa516cb9b5
--- /dev/null
+++ b/layouts/partials/redirects/sites.redirects
@@ -0,0 +1,41 @@
+{{/* Redirect for default language when .LanguagePrefix is empty. */ -}}
+
+{{ $defaultLang := "" -}}
+{{ with .Site.Sites.Default -}}
+ {{ if eq .LanguagePrefix "" -}}
+ {{ with .Language.Lang -}}
+ {{ $defaultLang = . -}}
+ /{{ . }} /
+ /{{ . }}/* /:splat
+ {{ end -}}
+ {{ end -}}
+{{ end -}}
+
+{{/* Process non-default languages. */ -}}
+
+/ja/docs/specs /en/docs/specs/ 301!
+
+{{ range after 1 .Sites -}}
+
+ {{ $siteLang := .Language.Lang -}}
+
+ # Site localization {{ $siteLang }}
+ {{ range $p := .Pages -}}
+
+ {{ range $p.Params.redirects -}}
+ {{ $fallbackPage := partial "i18n/fallback-page.html" $p -}}
+ {{ if or (eq $siteLang $defaultLang) (not $fallbackPage) -}}
+ {{ $from := cond (strings.HasPrefix .from "/")
+ .from
+ (print $p.RelPermalink .from) -}}
+ {{ $to := cond (strings.HasPrefix .to "/")
+ .to
+ (print $p.RelPermalink .to) -}}
+ {{ $from | printf "%-35s" }} {{ $to }}
+ {{ else -}}
+ {{/* # {{ $p.RelPermalink }} */ -}}
+ {{ end -}}
+ {{ end -}}
+ {{ end -}}
+
+{{ end -}}
diff --git a/layouts/shortcodes/docs/languages/exporters/intro.md b/layouts/shortcodes/docs/languages/exporters/intro.md
index be714cb9b1e7..cc96afdd2006 100644
--- a/layouts/shortcodes/docs/languages/exporters/intro.md
+++ b/layouts/shortcodes/docs/languages/exporters/intro.md
@@ -46,14 +46,14 @@ them up.
{{ end -}}
-{{ with $.Page.GetPage "automatic/configuration" }}
{{ $l := cond (eq $lang "dotnet") "net" $lang }}
+{{ with $.Page.GetPage (print "/docs/zero-code/" $l "/configuration" ) }}
+
+ {{ partial "footer.html" . }}
+
+
+
+
+ {{ partial "version-banner.html" . }}
+ {{ if not .Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" . }}{{ end }}
+ {{ block "main" . }}{{ end }}
+
+
+ Note
-If you use [automatic instrumentation](/docs/languages/{{ $l }}/automatic) you can -learn how to setup exporters following the [Configuration -Guide](/docs/languages/{{ $l }}/automatic/configuration/). +If you use [zero-code instrumentation](/docs/zero-code/{{ $l }}), you can learn how +to set up exporters by following the [Configuration +Guide](/docs/zero-code/{{ $l }}/configuration/).![\"CNCF](\"/img/cncf-icon-color.svg\" "\\"CNCF"){kind=icon}
" (humanize .cncf) (humanize .cncf)) "" -}}
+[{{ .name }}]({{ .url }}){{ $cncfTag }} | {{- cond .oss "Yes" "No" }} | {{ delimit (sort .components) ", " }} | [{{ replace .docsUrl "https://" "" }}]({{ .docsUrl }})
{{- end }}
[^1]: Listed alphabetically
diff --git a/layouts/shortcodes/ja/docs/languages/resources-intro.md b/layouts/shortcodes/ja/docs/languages/resources-intro.md
new file mode 100644
index 000000000000..dd619ef9773d
--- /dev/null
+++ b/layouts/shortcodes/ja/docs/languages/resources-intro.md
@@ -0,0 +1,14 @@
+{{/*
+default_lang_commit: 1f992fb2
+*/ -}}
+
+
+{{ $processWord := .Get 0 | default "プロセス" -}}
+{{ $resourceHRef := "/docs/concepts/resources/" -}}
+{{ if eq .Page.RelPermalink $resourceHRef -}}
+ {{ $resourceHRef = "/docs/specs/otel/resource/sdk/" -}}
+{{ end -}}
+
+[リソース]({{ $resourceHRef }})は、リソース属性としてテレメトリーを生成するエンティティを表します。たとえば、Kubernetes上のコンテナで実行されているテレメトリーを生成する{{ $processWord }}は、{{ $processWord }}名、ポッド名、ネームスペース、および場合によってはデプロイメント名を持ちます。これらの4つの属性すべてをリソースに含まれることができます。
+
+オブザーバビリティバックエンドでは、リソース情報を使用して興味深い動作をより詳細に調査できます。たとえば、トレースまたはメトリクスデータがシステムのレイテンシーを示している場合、それを特定のコンテナ、ポッド、またはKubernetesデプロイメントに絞り込むことができます。
diff --git a/layouts/shortcodes/logs-support-table.md b/layouts/shortcodes/logs-support-table.md
deleted file mode 100644
index c8233ec74f82..000000000000
--- a/layouts/shortcodes/logs-support-table.md
+++ /dev/null
@@ -1,15 +0,0 @@
-{{ $data := $.Site.Data.instrumentation }}
-
-Language | Logs |
-| --- | --- |
-| [C++](/docs/languages/cpp/) | {{ $data.cpp.status.logs | humanize }} |
-| [C#/.NET](/docs/languages/net/) | {{ $data.dotnet.status.logs | humanize }} |
-| [Erlang/Elixir](/docs/languages/erlang/) | {{ $data.erlang.status.logs | humanize }} |
-| [Go](/docs/languages/go/) | {{ $data.go.status.logs | humanize }} |
-| [Java](/docs/languages/java/) | {{ $data.java.status.logs | humanize }} |
-| [JavaScript](/docs/languages/js/) | {{ $data.js.status.logs | humanize }} |
-| [PHP](/docs/languages/php/) | {{ $data.php.status.logs | humanize }} |
-| [Python](/docs/languages/python/) | {{$data.python.status.logs | humanize }} |
-| [Ruby](/docs/languages/ruby/) | {{ $data.ruby.status.logs | humanize }} |
-| [Rust](/docs/languages/rust/) | {{ $data.rust.status.logs | humanize }} |
-| [Swift](/docs/languages/swift/) | {{ $data.swift.status.logs | humanize }} |
diff --git a/layouts/shortcodes/metrics-support-table.md b/layouts/shortcodes/metrics-support-table.md
deleted file mode 100644
index a02f8acce7d2..000000000000
--- a/layouts/shortcodes/metrics-support-table.md
+++ /dev/null
@@ -1,15 +0,0 @@
-{{ $data := $.Site.Data.instrumentation }}
-
-Language | Metrics |
-| --- | --- |
-| [C++](/docs/languages/cpp/) | {{ $data.cpp.status.metrics | humanize }} |
-| [C#/.NET](/docs/languages/net/) | {{ $data.dotnet.status.metrics | humanize }} |
-| [Erlang/Elixir](/docs/languages/erlang/) | {{ $data.erlang.status.metrics | humanize }} |
-| [Go](/docs/languages/go/) | {{ $data.go.status.metrics | humanize }} |
-| [Java](/docs/languages/java/) | {{ $data.java.status.metrics | humanize }} |
-| [JavaScript](/docs/languages/js/) | {{ $data.js.status.metrics | humanize }} |
-| [PHP](/docs/languages/php/) | {{ $data.php.status.metrics | humanize }} |
-| [Python](/docs/languages/python/) | {{$data.python.status.metrics | humanize }} |
-| [Ruby](/docs/languages/ruby/) | {{ $data.ruby.status.metrics | humanize }} |
-| [Rust](/docs/languages/rust/) | {{ $data.rust.status.metrics | humanize }} |
-| [Swift](/docs/languages/swift/) | {{ $data.swift.status.metrics | humanize }} |
diff --git a/layouts/shortcodes/sampling-support-list.md b/layouts/shortcodes/sampling-support-list.md
index a827f8850200..6ae3c7f3aa02 100644
--- a/layouts/shortcodes/sampling-support-list.md
+++ b/layouts/shortcodes/sampling-support-list.md
@@ -6,5 +6,5 @@
{{- end }}
{{ define "list-item" -}}
-- [{{ .name }}]({{ .page.RelPermalink }})
+- {{ .name }}
{{ end -}}
diff --git a/layouts/shortcodes/signal-support-table.md b/layouts/shortcodes/signal-support-table.md
new file mode 100644
index 000000000000..3e86d69f75e7
--- /dev/null
+++ b/layouts/shortcodes/signal-support-table.md
@@ -0,0 +1,16 @@
+{{ $data := $.Site.Data.instrumentation }}
+{{ $signal := .Get 0 -}}
+
+Language | {{ humanize $signal }} |
+| --- | --- |
+| [C++](/docs/languages/cpp/) | {{ index $data.cpp.status $signal | humanize }} |
+| [C#/.NET](/docs/languages/net/) | {{ index $data.dotnet.status $signal | humanize }} |
+| [Erlang/Elixir](/docs/languages/erlang/) | {{ index $data.erlang.status $signal | humanize }} |
+| [Go](/docs/languages/go/) | {{ index $data.go.status $signal | humanize }} |
+| [Java](/docs/languages/java/) | {{ index $data.java.status $signal | humanize }} |
+| [JavaScript](/docs/languages/js/) | {{ index $data.js.status $signal | humanize }} |
+| [PHP](/docs/languages/php/) | {{ index $data.php.status $signal | humanize }} |
+| [Python](/docs/languages/python/) | {{index $data.python.status $signal | humanize }} |
+| [Ruby](/docs/languages/ruby/) | {{ index $data.ruby.status $signal | humanize }} |
+| [Rust](/docs/languages/rust/) | {{ index $data.rust.status $signal | humanize }} |
+| [Swift](/docs/languages/swift/) | {{ index $data.swift.status $signal | humanize }} |
diff --git a/layouts/shortcodes/spec_status.html b/layouts/shortcodes/spec_status.html
index a78cb177715d..3a3e85d10102 100644
--- a/layouts/shortcodes/spec_status.html
+++ b/layouts/shortcodes/spec_status.html
@@ -25,7 +25,7 @@
- https://opentelemetry.io/docs/specs/otel/document-status/
- https://github.com/open-telemetry/opentelemetry-proto#maturity-level
*/ -}}
-{{ $statusValueRE := "(?i:experimental|stable|deprecated|removed|mixed|feature.freeze|alpha|beta)" -}}
+{{ $statusValueRE := "(?i:development|experimental|stable|deprecated|removed|mixed|feature.freeze|alpha|beta)" -}}
{{ $statusRE := printf "%s(,\\s*%s)*" $statusValueRE $statusValueRE -}}
{{ with findRE $statusRE $statusLine -}}
{{ $status = index . 0 -}}
diff --git a/package.json b/package.json
index 2fb33e4a9a0f..af4ab40adbc6 100644
--- a/package.json
+++ b/package.json
@@ -41,6 +41,7 @@
"cd:public": "cd public &&",
"check:filenames": "test -z \"$(npm run -s _ls-bad-filenames)\" || npm run -s _filename-error",
"check:format": "npm run _check:format && npm run _check:format:ja+zh || (echo '[help] Run: npm run fix:format'; exit 1)",
+ "check:i18n": "scripts/check-i18n.sh",
"check:links:internal": "npm run _check:links:internal",
"check:links": "npm run _check:links",
"check:markdown": "scripts/check-markdown-wrapper.sh",
@@ -58,7 +59,10 @@
"fix:dict": "find content layouts -name \"*.md\" -print0 | xargs -0 scripts/normalize-cspell-front-matter.pl",
"fix:filenames": "npm run _rename-to-kebab-case",
"fix:format": "npm run format",
- "fix:i18n": "scripts/i18n-check.sh -u",
+ "fix:i18n:all": "scripts/check-i18n.sh -a -c HEAD",
+ "fix:i18n:drifted": "scripts/check-i18n.sh -c HEAD",
+ "fix:i18n:new": "scripts/check-i18n.sh -n -c HEAD",
+ "fix:i18n": "npm run fix:i18n:new",
"fix:markdown": "npm run check:markdown -- --fix",
"fix:refcache": "npm run check:links",
"fix:submodules": "npm run _sync",
@@ -111,7 +115,7 @@
"textlint": "^14.0.4",
"textlint-filter-rule-allowlist": "^4.0.0",
"textlint-filter-rule-comments": "^1.2.2",
- "textlint-rule-terminology": "^5.0.10",
+ "textlint-rule-terminology": "^5.0.15",
"through2": "^4.0.2",
"yargs": "^17.7.2"
},
diff --git a/scripts/check-i18n.sh b/scripts/check-i18n.sh
new file mode 100755
index 000000000000..df729741a05b
--- /dev/null
+++ b/scripts/check-i18n.sh
@@ -0,0 +1,327 @@
+#!/bin/bash
+#
+# Inspired by https://github.com/kubernetes/website/blob/main/scripts/lsync.sh
+
+COMMIT_HASH_ARG=""
+DEFAULT_CONTENT="content"
+DEFAULT_LANG="en"
+DEFAULT_TARGET="$DEFAULT_CONTENT"
+EXIT_STATUS=0
+EXTRA_DIFF_ARGS="--numstat"
+FLAG_DIFF_DETAILS=""
+FLAG_FAIL_ON_LIST_OR_MISSING=0
+FLAG_INFO=""
+FLAG_QUIET=""
+FLAG_VERBOSE=""
+I18N_DLC_KEY="default_lang_commit"
+LIST_KIND="DRIFTED" # or "ALL" or "NEW"
+TARGET_PATHS=""
+
+
+function _usage() {
+ cat <