wbtiger
/
foundationdb
mirror of https://github.com/apple/foundationdb.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
foundationdb/fdbserver/MutationTracking.h

48 lines
2.1 KiB
C
Raw Normal View History

Clean up and rework the debugMutation API. As a relatively unknown debugging tool for simulation tests, one could have simulation print when a particular key is handled in various stages of the commit process. This functionality was enabled by changing a 0 to a 1 in an #if, and changing a constant to the key in question. As a proxy and storage server handle mutations, they call debugMutation or debugKeyRange, which then checks against the mutation against the key in question, and logs if they match. A mixture of printfs and TraceEvents would then be emitted, and for this to actually be usable, one also needs to comment out some particularly spammy debugKeyRange() calls. This PR reworks the API of debugMutation/debugKeyRange, pulls it out into its own file, and trims what is logged by default into something useful and understandable: * debugMutation() now returns a TraceEvent, that one can add more details to before it is logged. * Data distribution and storage server cleanup operations are no longer logged by default
2020-03-27 16:35:26 +08:00
/*
* MutationTracking.h
*
* This source file is part of the FoundationDB open source project
*
Update copyright header dates
2022-03-22 04:36:23 +08:00
* Copyright 2013-2022 Apple Inc. and the FoundationDB project authors
Clean up and rework the debugMutation API. As a relatively unknown debugging tool for simulation tests, one could have simulation print when a particular key is handled in various stages of the commit process. This functionality was enabled by changing a 0 to a 1 in an #if, and changing a constant to the key in question. As a proxy and storage server handle mutations, they call debugMutation or debugKeyRange, which then checks against the mutation against the key in question, and logs if they match. A mixture of printfs and TraceEvents would then be emitted, and for this to actually be usable, one also needs to comment out some particularly spammy debugKeyRange() calls. This PR reworks the API of debugMutation/debugKeyRange, pulls it out into its own file, and trims what is logged by default into something useful and understandable: * debugMutation() now returns a TraceEvent, that one can add more details to before it is logged. * Data distribution and storage server cleanup operations are no longer logged by default
2020-03-27 16:35:26 +08:00
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef _FDBSERVER_MUTATIONTRACKING_H_
#define _FDBSERVER_MUTATIONTRACKING_H_
#pragma once
#include "fdbclient/FDBTypes.h"
#include "fdbclient/CommitTransaction.h"
And fix a couple more issues from me doing manual things wrong.
2020-03-27 19:04:13 +08:00
#define MUTATION_TRACKING_ENABLED 0
Add a bit of documentation, and the TODO trail for future work.
2020-05-14 09:44:22 +08:00
// The keys to track are defined in the .cpp file to limit recompilation.
Clean up and rework the debugMutation API. As a relatively unknown debugging tool for simulation tests, one could have simulation print when a particular key is handled in various stages of the commit process. This functionality was enabled by changing a 0 to a 1 in an #if, and changing a constant to the key in question. As a proxy and storage server handle mutations, they call debugMutation or debugKeyRange, which then checks against the mutation against the key in question, and logs if they match. A mixture of printfs and TraceEvents would then be emitted, and for this to actually be usable, one also needs to comment out some particularly spammy debugKeyRange() calls. This PR reworks the API of debugMutation/debugKeyRange, pulls it out into its own file, and trims what is logged by default into something useful and understandable: * debugMutation() now returns a TraceEvent, that one can add more details to before it is logged. * Data distribution and storage server cleanup operations are no longer logged by default
2020-03-27 16:35:26 +08:00
apply clang-format to *.c, *.cpp, *.h, *.hpp files
2021-08-28 08:07:47 +08:00
#define DEBUG_MUTATION(...) MUTATION_TRACKING_ENABLED&& debugMutation(__VA_ARGS__)
Move role UIDs for MutationTracking TraceEvents from various inconsistent detail fields into the TraceEvent UID field.
2021-08-10 16:52:36 +08:00
TraceEvent debugMutation(const char* context, Version version, MutationRef const& mutation, UID id = UID());
Resolve performance concerns of nearly-no-op debugMutation being frequently called This introduces unhygenic macro variants that inline a `ENABLED &&` before the TraceEvent. This way, they get entirely compiled out unless enabled. Then rewrite all debugMutation uses via sed.
2020-05-14 05:28:04 +08:00
Add a bit of documentation, and the TODO trail for future work.
2020-05-14 09:44:22 +08:00
// debugKeyRange and debugTagsAndMessage only log the *first* occurrence of a key in their range/commit.
Enforce std:: specifier rather than using namespace
2021-09-17 08:42:34 +08:00
// TODO: Create a TraceEventGroup that forwards all calls to each element of a std::vector<TraceEvent>,
Add a bit of documentation, and the TODO trail for future work.
2020-05-14 09:44:22 +08:00
// to allow "multiple" TraceEvents to be returned.
apply clang-format to *.c, *.cpp, *.h, *.hpp files
2021-08-28 08:07:47 +08:00
#define DEBUG_KEY_RANGE(...) MUTATION_TRACKING_ENABLED&& debugKeyRange(__VA_ARGS__)
Move role UIDs for MutationTracking TraceEvents from various inconsistent detail fields into the TraceEvent UID field.
2021-08-10 16:52:36 +08:00
TraceEvent debugKeyRange(const char* context, Version version, KeyRangeRef const& keys, UID id = UID());
Clean up and rework the debugMutation API. As a relatively unknown debugging tool for simulation tests, one could have simulation print when a particular key is handled in various stages of the commit process. This functionality was enabled by changing a 0 to a 1 in an #if, and changing a constant to the key in question. As a proxy and storage server handle mutations, they call debugMutation or debugKeyRange, which then checks against the mutation against the key in question, and logs if they match. A mixture of printfs and TraceEvents would then be emitted, and for this to actually be usable, one also needs to comment out some particularly spammy debugKeyRange() calls. This PR reworks the API of debugMutation/debugKeyRange, pulls it out into its own file, and trims what is logged by default into something useful and understandable: * debugMutation() now returns a TraceEvent, that one can add more details to before it is logged. * Data distribution and storage server cleanup operations are no longer logged by default
2020-03-27 16:35:26 +08:00
apply clang-format to *.c, *.cpp, *.h, *.hpp files
2021-08-28 08:07:47 +08:00
#define DEBUG_TAGS_AND_MESSAGE(...) MUTATION_TRACKING_ENABLED&& debugTagsAndMessage(__VA_ARGS__)
Move role UIDs for MutationTracking TraceEvents from various inconsistent detail fields into the TraceEvent UID field.
2021-08-10 16:52:36 +08:00
TraceEvent debugTagsAndMessage(const char* context, Version version, StringRef commitBlob, UID id = UID());
Add a bit of documentation, and the TODO trail for future work.
2020-05-14 09:44:22 +08:00
apply clang-format to *.c, *.cpp, *.h, *.hpp files
2021-03-11 02:06:03 +08:00
// TODO: Version Tracking. If the bug is in handling a version rather than a key, then it'd be good to be able to log
// each time that version is handled within simulation. A similar set of functions should be implemented.
Add a bit of documentation, and the TODO trail for future work.
2020-05-14 09:44:22 +08:00
Clean up and rework the debugMutation API. As a relatively unknown debugging tool for simulation tests, one could have simulation print when a particular key is handled in various stages of the commit process. This functionality was enabled by changing a 0 to a 1 in an #if, and changing a constant to the key in question. As a proxy and storage server handle mutations, they call debugMutation or debugKeyRange, which then checks against the mutation against the key in question, and logs if they match. A mixture of printfs and TraceEvents would then be emitted, and for this to actually be usable, one also needs to comment out some particularly spammy debugKeyRange() calls. This PR reworks the API of debugMutation/debugKeyRange, pulls it out into its own file, and trims what is logged by default into something useful and understandable: * debugMutation() now returns a TraceEvent, that one can add more details to before it is logged. * Data distribution and storage server cleanup operations are no longer logged by default
2020-03-27 16:35:26 +08:00
#endif