Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Telemetry: save if Read the Docs creates a conf.py file for the project #9664

Closed
humitos opened this issue Oct 17, 2022 · 3 comments
Closed
Labels
Needed: design decision A core team decision is required

Comments

@humitos
Copy link
Member

humitos commented Oct 17, 2022

It would be good to save into the build data if Read the Docs is creating the Sphinx's conf.py file for them. Sometimes we refer to this as the Magic Builder.

We are currently logging this into New Relic:

log.info(
'Creating default Sphinx config file for project.',
project_slug=self.project.slug,
version_slug=self.version.slug,
)
and we can see the data at https://onenr.io/0qQa3nMA5R1. We had 1.6k projects in the last 90 days.

Note that it seems this feature it's not heavily used, so it may not be super useful to start storing it into our database and it may be more useful to start thinking about its deprecation instead.

@humitos humitos added the Needed: design decision A core team decision is required label Oct 17, 2022
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Jun 28, 2023
@humitos
Copy link
Member Author

humitos commented Jun 28, 2023

I think we can re-purpose this issue at some point and instead of start logging data in Telemetry database, talk more about deprecate this feature and avoid auto-creation of a conf.py file for projects that don't have one. See #9779 for more information about the deprecation patterns we are following.

@humitos
Copy link
Member Author

humitos commented Jun 30, 2023

I grepped the logs because NR only gives me the result for 1k project slugs only. Maybe there is a way to get more, but I didn't find it.

zgrep "Creating default Sphinx config file for project." /var/log/readthedocs/*.log* > project-conf-py-2023-06-30.txt
In [1]: lines = open('project-conf-py-2023-06-30.txt').readlines()

In [2]: projects = set()
   ...: for l in lines:
   ...:     projects.add(l.split('project_slug=')[1].split()[0])

In [3]: len(projects)
Out[3]: 1551

So, we have 1.5k projects that are using this feature. I will check how many of them are valid/active/non-spam now.

@humitos
Copy link
Member Author

humitos commented Jun 30, 2023

It seems we already agreed on removing this feature at #9562 (comment). So, I'll close this issue and follow the conversation there.

@humitos humitos closed this as completed Jun 30, 2023
@github-project-automation github-project-automation bot moved this from Planned to Done in 📍Roadmap Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: design decision A core team decision is required
Projects
Archived in project
Development

No branches or pull requests

1 participant